http://didou.nexenservices.com/missing.php
didou
Nuno Lopes wrote:
Personally I love the examples in the manual... I'm gonna start working...
----- Original Message ----- From: "Mehdi Achour" <[EMAIL PROTECTED]>
To: "Nuno Lopes" <[EMAIL PROTECTED]>
Cc: "PHPdoc" <[EMAIL PROTECTED]>; <[EMAIL PROTECTED]>
Sent: Tuesday, December 16, 2003 3:50 PM
Subject: Re: what can I do?
Hi,
Hi Nuno :)
As you know I'm new here. Now I would like to know what can I do to
help.
(please give me easy things first because I'm not a docbook expert...)
for me it will be a coffee and .. sorry.
A long time ago, Phillip (someone told me that) have started a big battle to have an example for each function in the manual.
Not so long ago, I've did the same thing, but lost the script :-s
Today Dave Carr have rewritten the script, and it works like a charm. I'm sure he will be glad to share it with you. For the moment, here's an interface to see what function need an example :
http://didou.keliglia.com/phpdoc/missing.php
The docbook syntax to add an example is :
<para> <example> <title></title> <programlisting role="php"> <![CDATA[ <?php
// example
?> ]]> </programlisting> </example> </para>
If your example output something huge (a print_r() for example), and you want to show it to the user, use this :
<para> <example> <title></title> <programlisting role="php"> <![CDATA[ <?php
var_dump(get_defined_vars());
?> ]]> </programlisting> <para> The above example will output: </para> <screen> <![CDATA[ Array ( .... ) ]]> </screen> </example> </para>
Please : - make test before each commit - use coding standards in the PHP examples - don't add example to aliases or deprecated functions
Have fun ;)
didou
