RE: [PEAR-DEV] Real documentation?
| From: | Richard Heyes | Date: | Sun, 12 Aug 2001 21:58:12 +0000 |
| Subject: | RE: [PEAR-DEV] Real documentation? | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1408@lists.php.net to get a copy of this message | ||
> I recently proposed a central "doc" dir where packages documentation are
> installed separatly in the form: doc/<package_name-release>/. In your
> package simply create a dir called "doc" and mark it as Role="doc":
>
> <FileList>
> <Dir Name="/" Role="php">
> <File>Mail.php</File>
> <Dir Name="Mail">
> <File>sendmail.php</File>
> <Dir Name="doc" Role="doc">
> <File>examples_sendmail.php</File>
> </Dir>
> </Dir>
> </Dir>
> </FileList>
Sounds good, but doesn't the above imply the docs dir sitting in the same
place as the file?
> The installer could be easily modified to install all the 'Role="doc"'
> files under PEAR_DOC_DIR/mail-1.2/ (PEAR_DOC_DIR is a new php constant).
> This new constant or something similiar (PHP_DATA_DIR/peardocs?) is
> needed because we probably don't want to have all the docs and examples
> under the include_path.
Where would they sit in cvs though, /doc(s)/package_name/ perhaps?
--
Richard "Wanting to commit some docs soon" Heyes
"I find television very educating. Every time somebody turns on the
set, I go into the other room and read a book. " - Groucho Marx