On Sat, 18 Dec 2010 04:11:28 +1100 Kim Lester <k...@dfusion.com.au> wrote:
> All, > > A few notes and two requests (marked *** ) > > 1) > Attached is a 0th order draft of a proposed EFL manual to replace all the > other "manuals". Or more accurately here is a half written manual to replace > the other half written manuals :-) > > I've cannibalised all the other sources of info that I could find. Once > complete and if everyone is happy I suggest the old docs be moved into an > ARCHIVE directory (or similar) so they are not accidentally used to provide > incorrect info (not that I'm claiming this manual is 100% accurate yet) > > I have deliberately take some additional info from the doxygen "main page". I > don't see doxygen as a suitable "user guide documentation tool" so if there > is overview stuff in doxygen IMHO it is better in a proper document and leave > doxygen for source code docs and maybe the odd code example. > > *** I would appreciate feedback on this document. > > Incidentally I wrote this in OO simply because writing either doxygen or xml > is not a good way to evolve a large complex document. I've written large docs > in TeX with vi before and whilst it is good for producing consistent output > it sucks from the point of view of massive cut/pastes and "creative flow". > Eventually this doc _could_ be converted to xml or tex or something but not > just now. I noticed you left out eina_hamster from your documentation. This is unacceptable. Ecore Dbus does not exist, it's e_dbus. Eeze is currently only functional on systems that support udev (only linux afaik?). Looks pretty good for a rough draft, A++ would read again. > > > 2) > My suggestion is we create 3 sources of reference documentation (excluding > the "casual" wiki for ad-hoc info) > > 1) The EFL Manual > 2) The Edje User Guide (not yet written) > 3) The API source. Edje documentation needs a lot of work. A large amount of the info for it is actually still on the old wiki. > > > 3) > IMHO there are far too many sources and types of info for E at the moment and > too many enlightenment subdomains (confusing to me anyway). Agree. > Info sources > 1) web site > 2) wiki > 3) misc docs in SVN (trunk/DOCS) > 4) doxygenated source (auto) > 5) doxygentated source (out of date - late 2009) > > I've stated cleaning up the wiki (done about 20 pages) - see RecentChanges > page for last week. I have a list of pages I think should be deleted but I'm > not game to do that yet. I think the website (not wiki) needs a bit of > tweaking too. > > *** I would appreciate some feedback on the wiki changes before I > contemplate doing any more work. > -- Mike Blumenkrantz Zentific: We run the three-legged race individually. ------------------------------------------------------------------------------ Lotusphere 2011 Register now for Lotusphere 2011 and learn how to connect the dots, take your collaborative environment to the next level, and enter the era of Social Business. http://p.sf.net/sfu/lotusphere-d2d _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
