[OGo-Documentation] developer documentation

Sebastian Reitenbach documentation@opengroupware.org
Thu, 06 Dec 2007 09:05:37 +0100


Hi,

as said, i'd start a bit developer documentation.


I'd also think, the document should start with an introductional chapter on 
debugging ogo using gdb. So with my little knowledge, I would suggest, 
starting there. When I have this, then I'd go on, explaining all the neat 
enhancements I've done over the past, the AsteriskDialer plugin, the 
AsteriskUI, some enhancements on the Chat-page in Misc, stuff like that.
For these modules, I thought, explaining each in one chapter, directory 
structure layout, GNUmakefiles, *plist files, and in the end how the 
objective-c and webobjects are working together to get the module used in 
the WebUI. 

While I was just fiddling around with the AsteriskDialer, I'd start with 
explaining how I added that piece.

But be warned, all my knowledge on how OGo is working internally, is just 
from reading docs and sources, asking here on the mailing lists, and making 
assumptions and guesses out of findings. So there will be errors and piece 
missing, that I just don't know (better).


Before that, some questions should be clarified:
* Just start with a *txt file, to get it fast working, or better from the 
beginning using a odf file?
* In case of *odf file, Adam, do you have an empty one, that you use for the 
admin and users docs, but with all the styles already in there? I'd suggest 
that these documents should look similar.

greetings
Sebastian