cvs: phpdoc / README

goba Fri Apr 11 11:15:27 2003 EDT Modified files: /phpdoc README Log: Shorten howto URLs with the newly added shortcuts, and remove anoncvs instructions. They are simply misleading. The howto perfectly covers the CVS issues... Also reorder howto info, so the easier is the first one (assuming guys just getting to know phpdoc would like to read it online first). Index: phpdoc/README diff -u phpdoc/README:1.30 phpdoc/README:1.31 --- phpdoc/README:1.30 Wed Feb 12 14:08:24 2003 +++ phpdoc/README Fri Apr 11 11:15:27 2003 @@ -8,7 +8,7 @@ about how the XML stuff works. If you just want to read the documentation, look at: - http://www.php.net/docs.php + http://www.php.net/docs --------------------------------------------------------------------------- HOW TO WRITE PHPDOC FILES @@ -17,25 +17,21 @@ set up the tools needed, how to work with CVS and DocBook on Linux or Windows, or what conventions you should follow when writing phpdoc files, please refer - to the PHP Documentation HOWTO. You can find it in - the howto directory of the phpdoc module which can - be build locally like so: + to the PHP Documentation HOWTO. + + You can read the HOWTO online at: + http://php.net/dochowto + + Or download a tar.gz containing the whole contents: + http://php.net/get/dochowto + + If you are already working with the phpdoc module, + then you can find it's XML source in the howto directory + of the module, and build it yourself with: make howto cd howto/html/ - It can also be downloaded from the web or viewed online: - - http://www.php.net/manual/howto/ - http://cvs.php.net/co.php/phpdoc/howto/howto.html.tar.gz?p=1 - - For questions on how to use CVS, consult the anoncvs docs and - apply to your (phpdoc) needs. Remember to use your PHP CVS - username/password and checkout the module named phpdoc. - Translation information is located in the HOWTO. - - http://www.php.net/anoncvs.php - --------------------------------------------------------------------------- FILE LOCATIONS --------------------------------------------------------------------------- @@ -109,9 +105,9 @@ <filename> filenames <constant> constants <varname> variables - <parameter> a functions parameter/argument + <parameter> a function's parameter/argument <function> functions, this links to function pages or bolds if - already in functions page. it also adds (). + already on the function's page. it also adds (). <literal> teletype/mono-space font <tt> <emphasis> italics