Re: Random Thoughts About Pear-Doc
| From: | Mark Mitchenall | Date: | Sat, 17 Apr 2004 13:48:15 +0000 |
| Subject: | Re: Random Thoughts About Pear-Doc | ||
| References: | 1 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3601@lists.php.net to get a copy of this message | ||
Daniel Convissor wrote:
A quick turnaround means people writing the docs would be able to submit and validate their changes (as well as viewing how they look in the live manual) without having to go through the hastle of installing the build/validation tools on their own computers. Installing these tools seems to me to be THE biggest impediment to the PEAR docs.Writing DocBook doesn't have to be difficult. I used a combination of the XMLMind XML Editor (http://www.xmlmind.com/xmleditor/) and <oXygen/> XML Editor (http://www.oxygenxml.com/) to get start with it recently and found everything very straight forward, including producing PDFs which some users prefer so that they can print out the docs and read them away from the computer. The templates provided for PEAR documentation seem to make it fairly easy to write docs for packages. I think from a publishing point of view, using DocBook makes a lot of sense as there's already a large selection of tools to convert it into a variety of useful formats. I haven't tried out the PEARdoc tools myself yet, but from an editing and validating point of view, the above two editors seem to work fine. Best, Mark -- Mark Mitchenall, Standingwave Ltd (Complete Hosting and Development Services) Tel := +44 (0)20 8452 3031 Email := mark@standingwave.co.uk mark@mitchenall.com Home := http://www.standingwave.co.uk http://www.mitchenall.com