Index of /Programming/PHP/phpdoc/
---------------------------------------------------------------------------
READ THIS FIRST
---------------------------------------------------------------------------
This directory contains source files and a setup for converting
PHP's XML documentation into presentation formats like HTML and
RTF. You should not have to bother with this unless you are
writing documentation yourself, or if you simply are curious
about how the XML stuff works.
If you just want to read the documentation, look at:
http://www.php.net/docs
---------------------------------------------------------------------------
HOW TO WRITE PHPDOC FILES
---------------------------------------------------------------------------
If you are interested in information about how to
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 read the HOWTO online at:
http://doc.php.net/php/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 its XML source in the howto directory
of the module, and build it yourself with:
make howto
cd howto/html/
---------------------------------------------------------------------------
FILE LOCATIONS
---------------------------------------------------------------------------
The file locations are as follows:
{lang}/reference/{extension}
/book.xml
/setup.xml
/configure.xml [often part of setup.xml]
/constants.xml
/ini.xml [often part of setup.xml]
When the extension defines functions:
/reference.xml
/functions/{function}.xml
When the exetnsion defines classess:
/{classname}.xml
/{classname}/{methodname}.xml
/entities.*.xml (autogenerated)
Translated files live within their own CVS modules.
(Skeletons for these files are available in RFC/skeletons/)
---------------------------------------------------------------------------
QUICK REFERENCE
---------------------------------------------------------------------------
[[edits]]
a) Make the change. Use spaces not tabs. Be sure to carefully
watch your whitespace!
b) Look at your unified diff, make sure it looks right and that
whitespace changes aren't mixed in:
cvs diff -u path/to/file.xml
Hint: Use the .cvsrc example from http://php.net/anoncvs
c) Make sure no errors are present, so at the command line in your
phpdoc source directory run:
php configure.php
Always 'php configure.php' before commit!
Because configure.php takes so long you may instead check one file at a
time by using the xml-check.php script like so:
scripts/xml-check.php en/reference/mysql/functions/mysql-connect.xml
d) Commit your changes
cvs commit path/to/file.xml
Read the HOWTO for more information. After reading the HOWTO,
email the phpdoc mailing list (phpdoc@lists.php.net) with questions
and concerns.
[[new functions]]
a) Copy an existing xml file or use a skeleton from the HOWTO.
Rename and place it into the appropriate directory.
b) Edit. Be sure no leftover text exists. No tabs either.
c) Now test locally before commit by first running
(php configure.php)
d) cvs add path/to/yourfile.xml
e) cvs commit path/to/yourfile.xml
Note that the version numbers are taken care of elsewhere (don't worry
about them)
[[some popular tags and entities]]
filenames
constants
variables
a function's parameter/argument
functions, this links to function pages or bolds if
already on the function's page. it also adds ().
teletype/mono-space font
italics
see HOWTO, includes many other tags.
internal manual links
variables
external links via global.ent
mmm cookies
types, this links to the given types manual
page: object -> php.net/types.object
&return.success; see: language-snippets.ent
&true; TRUE
&false; FALSE
&php.ini; php.ini
Be sure to check out globals.ent and language-snippets.ent for
more information for entities and urls.
---------------------------------------------------------------------------
|
Parent Directory
CVS
LICENSE
contacts.txt