Re: Add end user doc to File_Archive

From: Date: Sun, 20 Feb 2005 20:11:29 +0000
Subject: Re: Add end user doc to File_Archive
References: 1  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-5550@lists.php.net to get a copy of this message
moving thread to pear-doc Vincent Lascaux wrote:
Hi, I would like to add an end user documentation for File_Archive (documentation that would be accessible from http://pear.php.net/package/File_Archive/docs). I've been said that I needed to put some files via CVS in the peardoc folder. Can you confirm that I have to follow these steps: - change the peardoc/en/package/fileformats.xml (add a "&package.fileformats.file-archive;" line after "&package.fileformats.contact-vcard-parse;") - add a peardoc/en/package/fileformats/file_archive.xml with an index - create a peardoc/en/package/fileformats/file_archive directory that will contain the actual documentation How often is the end user documentation generated?
Hi Vincent, It's a lot more complicated than that. To get a working skeleton, please checkout peardoc. If you're using unix, it should work pretty well out of the box (./configure && make html) the output will be in peardoc/html. Then you can experiment to your heart's content. Greg

« previous php.pear.doc (#5550) next »