[TYPO3-ect] TODO: Documentation of lib/div

[Elmar Hinz]

Hi,

Fabien suggest in the bug database to improve the documentation of lib/div
and asks for suggestions of mine.


A.) Sourcecode documentation:

This is primary documentation. That's my task and the task of all those who
contribute code. Christian Welzel did a big job to clean up all sourcecode
documentation so that it can be displayed with documentation tools.


B.) Wiki documentation:

I think the most easy way to maintain documentation by the users of lib/div
is to use the wiki. We should put prominent links into the sources and the
manual pointing to the wiki pages. It's obviously Daniel, who can suggest
the appropriate names for the wiki pages.


C.) Extension manuals for lib/div:

This are still a little chaotic. My vision is to provide 3 documents:

 1.) A developers API with general and special part.
 2.) A developers tutorial.
 3.) A template writers tutorial.

1.) A developers API with general and special part.

People can contribute the special part of the API by adding descriptions for
the classes. One class description per time. This should be done in plain
text to the API document in SVN. This way multiple persons can work on the
same document.

It's restructured text. Here is a renderer.
http://www.hosting4u.cz/jbar/rest/render.py

The general part is done. It replaces teh nutshell document:
http://svn.t3.digitaldistrict.de/cgi-bin/trac.cgi/browser/typo3xdev/tx_lib/trunk/doc/lib-div-api.txt
http://svn.t3.digitaldistrict.de/cgi-bin/trac.cgi/browser/typo3xdev/tx_lib/trunk/doc/lib-div-in-a-nutshell.txt


2.) A developers tutorial: 

This should be based on the example extensions of apples, banans, cherries.
That's the old manual.txt. Needs to be revisited and extended.


3.) A template writers tutorial.

Writing templates, PHP and other supported formats. Not that urgent.


Regards

Elmar