cvs: phpdoc / README

jeroen Thu Aug 9 17:25:51 2001 EDT Modified files: /phpdoc README Log: Update conventions. I believe there is consensus about these items, but if not, just replace them with better... Index: phpdoc/README diff -u phpdoc/README:1.12 phpdoc/README:1.13 --- phpdoc/README:1.12 Mon Jul 9 07:54:13 2001 +++ phpdoc/README Thu Aug 9 17:25:51 2001 @@ -50,6 +50,10 @@ 0 in the XML code. 5. All examples use the <?php ... ?> form instead of <? ... ?> + It can be useful to use <![CDATA[ ... ]]> for examples, since + it eliminates the need to change < to &lt;, etc. + + In examples, use the PEAR coding standard (it's in the manual itself) 6. The <refsect1><title> tag was set incorrectly when converting from sgml-tools. For normal function reference, the @@ -62,7 +66,25 @@ 8. If an example of using arguments specific to a newer version of php, it is helpful to note that in the example: - foo_function_exec ("bar", "baz"); // second argument was added in PHP 4.0.3 + foo("bar", "baz"); // second argument was added in PHP 4.0.3 + + Usually, in the form <note><simpara>Added in PHP 4.0.3</simpara></note> + + 9. The language-constants true, false and null should be written as + &true;, &false; and &null;. + + 10. All english xml-files should have a <!-- $Revision-comment as the + first, or in case of a <?xml tag, second line. + For non-english files, this isn't true. + + 11. Whitespace changes in the en-tree should be prevented as much as + possible: it is more important to keep a good change-history + of real changes, because of the translations. + If a whitespace change is _really_ needed, do it at least in + a separate commit, with as comment: 'WS fix' or 'Whitespace fix'. + + 12. More on whitespace: Never use spaces, indendation should be going + with 1 space at a time. WHAT TO DOCUMENT @@ -147,7 +169,7 @@ End: --> <!-- Keep this comment for vi/vim/gvim -vi: et:ts=1:sw=1 +vi: et:ts=1:sw=1:syntax=sgml --> END OF SKELETON