[OGo-Documentation] developer documentation

[Sebastian Reitenbach]

documentation@opengroupware.org wrote: 
> > 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. 
> 
> Doesn't sound bad;  I'd just make sure we don't start to create an
> Objective-C developers guide, etc...  Narrow and focused is good
> sticking to stuff that isn't already documented elsewhere.
Yeah, I do not want to do that either ;) I'll only very shortly talk about 
the Makefiles, then point to the GNUstep documentation. So wherever I am 
aware of external documentation, I'll point to it.

> 
> > 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).
> 
> Same here;  if there was documentation I would have read it. :)
Hey, but now we are at least two, with hopefully a bit different knowledge 
about that all, and I hope there will be comments from Helge and others 
later on too, to fill in the missing pieces.

Do you are aware of any documentation, that explains the various *plist 
files, their contents, and especially its meaning?
Lots of guides that I find are for xcode, where it says click here n there, 
and in the end there is a plist file :( Where only that stupid point n click 
is explained, but not how to create these things correctly from scratch with 
just a text editor.

> 
> > 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?
> 
> Certainly would work.  Text is easy enough to pull into anything.
> 
> > * 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.
> 
> I just use the default ones; if you link the document into an ODM the
> styles are easy enough to change globally.  The most import thing is to
> use headers 1 ,2, 3, etc... so you can automatically build a useful
> table of contents.  Second is to keep a list of keep terms and the like
> so it can be added to the index.
> 
OK, as I'm not a seasoned office program user, I'll take a plain .txt file 
for the start, and keep a list of interesting things to index separate.

greetings
Sebastian