Re: [PHP-DOC] Re: [PHP-WEBMASTER] [PHP Wiki] new user: antz29
Thanks Richard Downloading the docs now :) Where is a decent place to start putting my tutorials? I really wanted to create decent use cases and examples for SPL, as so many people know of it, but have no idea how or why they would implement it. Cheers John 2008/11/26 Richard Quadling [EMAIL PROTECTED]: 2008/11/26 Lukas Kahwe Smith [EMAIL PROTECTED]: On 26.11.2008, at 09:07, John Le Drew wrote: Hi Lukas I was talking to Steph over the weekend and wanted to put together a set of tutorials + examples for many of the features of PHP, starting with SPL. I thought that the Wiki would be a decent place for these, I also thought about adding them directly to the Docs but I wasn't sure where to start with that; I am familiar with DocBook etc. but not sure who to ask. I was thinking of creating all the pages under /tutorials. You should talk to the doc guys about this. Generally I think they prefer not to use a wiki for this, because they are worried the content will stay there instead of making it to the actual manual. The tool chain for docbook has gotten a lot simpler these days and I am sure they will be very happy to help you out. regards, Lukas Kahwe Smith [EMAIL PROTECTED] Hello John. The usual way to get started is to use CVS to download phpdoc and to get phd (the PHP document builder) via PEAR. Within phpdoc, there is a configure.php script. This essentially combines all the small XML docbook files into one expanded manual (called .manual.xml) phd then can process this file to make HTML, PHP, PDF, etc. You can make alterations to the phpdoc files and run through the configure and build process to test your changes. Then create a few small patches to let us see that you get it. After that, one of the more senior people will give you permission to commit those patches and off you go! Richard. -- - Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498r=213474731 Standing on the shoulders of some very clever giants!
[PHP-DOC] Error Compiling
Hi Just trying to build a fresh checkout and I'm getting -- ERROR (.../phpdoc/en/language/namespaces.xml:229:10) /para --^ Opening and ending tag mismatch: sect1 line 144 and para ERROR (.../phpdoc/en/language/namespaces.xml:256:10) /sect1 --^ Opening and ending tag mismatch: chapter line 3 and sect1 ERROR (.../phpdoc/en/language/namespaces.xml:1469:1) /chapter -^ chunk is not well balanced Previous errors too severe. Stopping here. -- Is this on the way to being fixed? Or is it something I'm getting wrong? Cheers John
[PHP-DOC] Documentation
Hi All I spoke to Steph at PHPNW about helping out with the docs. There are a few areas I would love to start work on right away (initially SPL) and I just wanted to find out what the best way of contributing was? I'm familiar with DocBook etc. Cheers John
Re: [PHP-DOC] Documentation
Hi again I want to create an Examples section within SPL for clear use cases and examples for each of the classes / interfaces within the SPL. The idea is that it seems that a lot of the current explanation is targeted very strongly at software engineers post their CS degree. The great majority of PHP users do not fall into this category and it would be great to see more people make use of the SPL classes / interfaces. What do you think? Cheers John 2008/11/26 Daniel Brown [EMAIL PROTECTED]: On Wed, Nov 26, 2008 at 6:46 AM, John Le Drew [EMAIL PROTECTED] wrote: Hi All I spoke to Steph at PHPNW about helping out with the docs. There are a few areas I would love to start work on right away (initially SPL) and I just wanted to find out what the best way of contributing was? I'm familiar with DocBook etc. Hey, John; Everyone starts off by submitting patches to the list first. After a couple of those, just go to the online form at http://www.php.net/cvs-php.php and follow the instructions there for requesting a CVS account and DOC karma. Any other questions, just zip them back to the list here and we'll all be happy to help you on your way. And thanks for volunteering! -- /Daniel P. Brown http://www.parasane.net/ [EMAIL PROTECTED] || [EMAIL PROTECTED] 1 LEFT: $149/mo. $0 Setup - Dual-Core/320GB HDD/1GB RAM/3TB 100Mbps/cPanel - SAME-DAY SETUP! Contact me to buy.
Re: [PHP-DOC] Documentation
Also Would I be able to look at breaking up 'Patterns' (Within classes and objects PHP5) and giving each pattern it's own page? And then perhaps adding a few more on top of Singleton and Factory... Would there be any opposition to this? Cheers John 2008/11/26 John Le Drew [EMAIL PROTECTED]: Hi again I want to create an Examples section within SPL for clear use cases and examples for each of the classes / interfaces within the SPL. The idea is that it seems that a lot of the current explanation is targeted very strongly at software engineers post their CS degree. The great majority of PHP users do not fall into this category and it would be great to see more people make use of the SPL classes / interfaces. What do you think? Cheers John 2008/11/26 Daniel Brown [EMAIL PROTECTED]: On Wed, Nov 26, 2008 at 6:46 AM, John Le Drew [EMAIL PROTECTED] wrote: Hi All I spoke to Steph at PHPNW about helping out with the docs. There are a few areas I would love to start work on right away (initially SPL) and I just wanted to find out what the best way of contributing was? I'm familiar with DocBook etc. Hey, John; Everyone starts off by submitting patches to the list first. After a couple of those, just go to the online form at http://www.php.net/cvs-php.php and follow the instructions there for requesting a CVS account and DOC karma. Any other questions, just zip them back to the list here and we'll all be happy to help you on your way. And thanks for volunteering! -- /Daniel P. Brown http://www.parasane.net/ [EMAIL PROTECTED] || [EMAIL PROTECTED] 1 LEFT: $149/mo. $0 Setup - Dual-Core/320GB HDD/1GB RAM/3TB 100Mbps/cPanel - SAME-DAY SETUP! Contact me to buy.
Re: [PHP-DOC] Documentation
Sounds good to me! I will press on with that unless we get any opposition... Cheers J 2008/11/26 Philip Olson [EMAIL PROTECTED]: I want to create an Examples section within SPL for clear use cases and examples for each of the classes / interfaces within the SPL. The idea is that it seems that a lot of the current explanation is targeted very strongly at software engineers post their CS degree. The great majority of PHP users do not fall into this category and it would be great to see more people make use of the SPL classes / interfaces. What do you think? Sounds great, please get started! :) There was a spurt of SPL documentation activity last week and maybe your work will help promote another one. Also, feel free to create an examples.xml for each class. So for example: phpdoc/en/reference/spl/arrayiterator/tutorial.xml From: phpdoc/RFC/skeletons/examples.xml An xml:id could be something like: spl.arrayiterator.examples-basic How does this sound to everyone, especially for PhD? Regards, Philip
Re: [PHP-DOC] Documentation
Hi All I think that each class/interface needs to have an 'Overview' section to give a high level view of it's purpose, some use cases, and a simple example. This could be the same example that is on the examples page for the class/interface. This should list each method with a link the the methods page, each method should also have a simple usage example. How does that sound? (and how could I do this within the current structure?) Cheers John 2008/11/26 John Le Drew [EMAIL PROTECTED]: Sounds good to me! I will press on with that unless we get any opposition... Cheers J 2008/11/26 Philip Olson [EMAIL PROTECTED]: I want to create an Examples section within SPL for clear use cases and examples for each of the classes / interfaces within the SPL. The idea is that it seems that a lot of the current explanation is targeted very strongly at software engineers post their CS degree. The great majority of PHP users do not fall into this category and it would be great to see more people make use of the SPL classes / interfaces. What do you think? Sounds great, please get started! :) There was a spurt of SPL documentation activity last week and maybe your work will help promote another one. Also, feel free to create an examples.xml for each class. So for example: phpdoc/en/reference/spl/arrayiterator/tutorial.xml From: phpdoc/RFC/skeletons/examples.xml An xml:id could be something like: spl.arrayiterator.examples-basic How does this sound to everyone, especially for PhD? Regards, Philip
[PHP-DOC] IRC
Is there an IRC channel that any of you guys hang out in? Cheers John
