RE: [PEAR-DEV] looking for volunteers phpDocumentor, new converter reST
| From: | Philip Olson | Date: | Fri, 13 Jun 2003 15:03:58 +0000 |
| Subject: | RE: [PEAR-DEV] looking for volunteers phpDocumentor, new converter reST | ||
| References: | 1 | Groups: | php.pear.dev php.pear.doc |
| Request: | Send a blank email to pear-dev+get-17403@lists.php.net to get a copy of this message | ||
For the record, I think it's a bad idea to use a format
different from phpdoc (the php manual). This only makes
the partnership between the two entities that more
difficult. And, then we have the PECL situation.
The phpdoc team has a meeting on July 10 and one topic
is to make it easier for people to write documentation.
Currently people require tools to do this (which IMHO
is not that difficult to setup and a good learning
experience, but whatever). The agenda talks about it,
here's a copy:
2. A user friendly translation / editing environment
http://boogle.com/tmp/2003_meeting_agenda.html
There is also something called "livedocs" that's being
worked on and is quite cool. It essentially generates
docs on the fly, is fast, and works. This works with
the current docbook setup and once ready to go online
can most likely work with the current peardoc (not the
reST format). Not much information on this yet but it
really does exist and is quite nice. See also #4 on
the agenda.
It's currently possible to setup build tools on both
Linux and Windows, and this task is even documented:
http://www.php.net/manual/howto/chapter-tools.html
http://www.php.net/manual/howto/tools-on-windows.html
So IMHO the cons outweigh the pros and this should not
be done, if phpdoc and peardoc are to get along.
Regards,
Philip