Re: peardoc2 quick tutorial (was PEAR Snippets)

thank you for encouraging. i do also need to write enough doc (but i seem to stupid to get the docbook stuff properly running:-( ) but this weekend will be dedicated to get it done. since i see the urgent need too :-) Alan Knowles wrote:

Most classes should be documented 'properly' with examples and comments when peardoc2 goes live.. One of the issues has been that while peardoc2 was in development, I guess alot of people have been hesitant to write peardoc2 documents.. For those who have not tried writing docs... start by reading. http://cvs.php.net/co.php/peardoc/peardoc2/en/authoring/readme.txt - other than attempting to use the 'automated' phpdocu->peardoc code, the easiest way is to look at an existing documented package and copy the files into your own folder. eg. creating html-template-yetanother a) create a file in /peardoc/peardoc2/en/package/html called html-template-yetanother.xml - copy from html-template-it.xml (edit the file and change the &package.html.html-template-it.*; to &package.html.html-template-yetanother.*; - each &line relates to a file (really a section) these files/sections are normally in a folder html-template-yetanother start by commenting out everything except for the intro line. with HTML type tags - eg. <!-- &html....... --> b) copy a 'page' from /peardoc/peardoc2/en/package/html/html-template-it like intro.xml into your directory /peardoc/peardoc2/en/package/html/html-template-yetanother open the file up and change all the id="...." like this <refentry id="package.html.html-template-it.intro"> to <refentry id="package.html.html-template-yetanother.intro"> Then play around with the content remembering - the order of tags is important (refsect1 must be followed by a title tag., text must be in para, simplepara or a few other tags.) - use <![CDATA[ ...... ]]> to put PHP, html etc. code in. (repeat for the other files in the folder - note the format is reasonably standard for most methods) c) add your package to the type file eg. peardoc/peardoc2/en/package/html.xml by adding the line &package.html.html-template-yetanother; Assuming you have managed to install the build tools for the manual Have a look at the PHP documentation for help on what tools are required and how to build it (yes it can be done on windows) http://www.php.net/manual/howto/index.html go to the peardoc/peardoc2/ directory For a first time build you would probably ./buildconf ./configure make (which will put all the html files in peardoc/peardoc2/) if you have made a change - I normally do touch manual.xml (if I just modified a file) or ./configure (if I added a page/section) then make. NOTE: it is important to build the manual after making changes as it syntax checks the xml! - and if you commit broken xml you will probably break the automated manual builds. Now go out an write peardoc2 :) Regards Alan Yavor Shahpasov wrote:

Hello , I was thinking today about snippets rpository for pear. We could have snippets or code samples for pear classes. Since finding uptodate documentation of most classes (no disrespect the PEAR doc has gone a long way, and am really happy it's there) is hard, I was thinking about a user contribution system where people could submit samples of how to do things with pear classes might be a good idea. Snippets could use the current package structure so there would be no need for categories. this would be a gret plus for newbies which are new to pear. If this idea gets accepted an willing to start implemnting it. It would require a new DB table and am thinking to submit a snippet a user would have to have a pear account to avoid moderation. More after feedback :) + or - what will it be Yavor

                  **** http://www.netsmartlogos.com ****
                        Latest Logos, ringtones, call now and win!!
                              **Powered by NetSmart.Com.Cy**

-- Wolfram ... translating template system ... http://os.visionp.de/modules/project/HTML_Template_Xipe ... authentication system .... http://sf.net/projects/auth ... and more at .... http://opensource.visionp.de