Your package will be documented before, see how
| From: | David Costa | Date: | Wed, 05 May 2004 01:28:00 +0000 |
| Subject: | Your package will be documented before, see how | ||
| Groups: | php.pear.dev php.pear.doc | ||
| Request: | Send a blank email to pear-dev+get-28800@lists.php.net to get a copy of this message | ||
Greetings from Amsterdam,
In lieu of visiting the various cultural night attractions offered by this city, I have finalized a script to auto generate manual entries for these packages which are externally documented (or the maintainer is willing to prepare some externally hosted documents), but where the maintainer has a real struggle to deal with Docbook and/or doesn't plan to learn it in the short term.
Here it is
http://pear.gurugeek.org/yawiki/index.php?area=peardoc&page=DoyourOwn
The link to the script is at the end of the page. (I will probably manage to embed it on the Wiki if Paul share some of the hints with me, looks like embed and insert are disabled :D )
It is a simple form, you just fill the form and the skeleton files are generated on the fly, saved on my test box, emailed to you in copy and to me.
It's not perfect, but it works.
This is not a final solution, but it allows you to keep the documentation in every format and link it to the manual.
I welcome your comments and suggestions,
Cheers
David Costa