Re: Writing Documentation

<alexander.merz@t-online.de> wrote : > Bertrand Mansion asked about how to write docs for the manual. > Here is a short description: > 1.) Ensure your PHPDoc comments are correct as possible (makes writing > easier) > 2.) run the pd2pm over the code - do not use the old version, i rewrote > it completely. I will provide an standalone pd2pm-archive after the > conference. (just be on the conf for a live demonstration :-) > 3.) Now you have a set of docbook templates and basical documentated > functions. This can be directly added to the pearman2 source. > 4.) Edit the templates (includes introduction and examples) and the > function docs. > > If you want to start already now, take a look on the HTML_Table docs i > commited this week - they are build after the notes above. Hi Alexander, Thanks for the work you did on HTML_Table :) It looks alright ! When do you plan on committing peardoc 2 to the live site ? What did you think of what I wrote about HTML_QuickForm ? It's more a tutorial than a standard API documentation so is there a place for that in peardoc ? Was my xml format alright or are there many things to change ? Thx Bertrand Mansion Mamasam