On Thu, Jan 22, 2009 at 23:37, Lukas Kahwe Smith <m...@pooteeweet.org> wrote: > > On 22.01.2009, at 22:50, Kenan R Sulayman wrote: > >> Hey Lukas! >> >> I want to document new features / update older ones and maybe correct >> several mistakes. >> >> I neither delete content nor change / fill it with inappropriate contents.
Hi Kenan! Is there anything specific you'd like to work on? Undocumented features? Extensions you think is lacking docs? Fixing reported bugs? We have a "dochowto" (http://php.net/dochowto) which should cover how to get started. If you have any specific questions then just let us know. We are also working on upgrading that howto to make it simpler to read and removing unnecessary information, see http://wiki.php.net/doc/scratchpad/howto. Basically, all you need to get started is a CVS client and PHP installed. Depending on your preferences, you may want to use a graphical CVS client (especially if you are a windows user), such as "TortoiseCVS". If you PHP and a CVS client already installed then here is a quick "getting started guide" 1) Do a "phpdoc" CVS checkout a) Login to the PHP CVS server $ cvs -d:pserver:cvsr...@cvs.php.net/repository login # The password is "phpfi" (see http://php.net/anoncvs) b) Checkout the module (called phpdoc) $ cvs -d:pserver:cvsr...@cvs.php.net/repository co phpdoc 2) Install PhD a) "Discover the PEAR channel" $ pear channel-discover doc.php.net b) Install the application $ pear install doc.php.net/phd-beta 3) Configure phpdoc and render the docs a) Goto the "phpdoc" directory (which was created by 1b) $ cd phpdoc b) Create a standalone XML file (.manual.xml) that can be rendered $ php configure.php c) Render the documentations $ phd -t chunkedhtml -d .manual.xml 4) Make sure everything is OK a) The 3c command created a new folder called "html/" containing ~7000 HTML files. Open up few of those files in your favorite browser to make sure everything is OK. If 4a passed the sanitychecking you are good to go to actually change the documentation. A quick explaination of the directory structure: phpdoc/ # Root folder. Contains bunch of things you don't need to worry about en/ # The folder containing the english documentations reference/ # Contains all the extension reference docs <extname>/functions # Contains functions specific docs You should probably read the "README" file in phpdoc/, it contains a good chunk of information (such as better overview of the file locations). After making adjustments to any file you will have to "test your changes", and you probably want to render the changes and view them in your browser. 1) $ php configure.php This will validate the XML files and produce a ".manual.xml" file which we then use to render the docs 2) $ phd -t chunkedhtml -d .manual.xml This will take the ".manual.xml" and produce a "chunked html", i.e. ~7.000 HTML files. If you are still reading.. Awesome! Please do send us email if there is something you are wondering about or need help with! -Hannes
