Re: PEAR Documentation
| From: | Mika Tuupola | Date: | Thu, 07 Nov 2002 22:30:12 +0000 |
| Subject: | Re: PEAR Documentation | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-10592@lists.php.net to get a copy of this message | ||
On Thu, 7 Nov 2002, Martin Jansen wrote:
> Hopefully this will be a shinning example for other future
> contributors. Right now about 99,9% of the PEAR packages aren't
> mentioned in the manual at all ;-).
One reason for this might be that starting to write
peardoc isn't that too easy. To write peardoc(2) it is almost
mandatory to have a working build enviroment to test out that
the conversion to html works. Otherwise you'll end up committing
broken xml to cvs.
And that is what I dont personally find too easy. For
example jade is quite a bitch to compile on Solaris.
Also properly setting up docbook for jade can also
be quite confusing.
So writing instructions on how to properly setup
build enviroment for peardoc on different platforms
might be a good idea (and I dont mean just apt-get or rpm
stuff).
Another possibility might be somekind of test enviroment
to which you can upload (via webform?) you xml and it
will show up what kind of html it would result.
--
Mika Tuupola http://www.appelsiini.net/~tuupola/