PEAR evangelism and PHP doc cross-referencing

From: Date: Sun, 18 Apr 2004 14:51:19 +0000
Subject: PEAR evangelism and PHP doc cross-referencing
Groups: php.pear.dev php.pear.doc 
Request: Send a blank email to pear-dev+get-27920@lists.php.net to get a copy of this message
Hi, Just a thought: To increase the reach of PEAR to all PHP users I suggest a documentation cross-referencing between the PHP doc and the PEAR doc (actually it would only need to be PHP doc to PEAR doc/packages.) Currently if you go to the PHP web site and browse the manual, there are rarely any references to PEAR and the packages. Usually the references are placed in the "User comments". I guess it should be pretty easy to do, although it has to be done by hand. Having a prominent place on the manual pages would be great. The links to PEAR packages could be like the current "See Also" function links. Of course, not all packages can and will be linked this way, but the idea is to start the flow of PHP developers to browse PEAR. To automate the linking in the future, maybe the package declaration should hint at where the package would be best linked in the PHP documentation. Maybe a @see or @link tag? Warning: Deprecation can be a problem. I'm pretty sure a lot of PHP developers are not aware of PEAR, and that's too bad. A lot of wheels are being re-invented daily because the developers are not aware of existing packages that do exactly what they want. Of course we could have all the package maintainers go to the PHP web and add a comment about their own packages in the "User Comments" but it doesn't seem to be the best option. Besides, you lose the user comments when you download the PHP manual. Cheers, -Philippe PS: This messae has been posted to PEAR-dev, PEAR-doc and PHP-doc lists.

« previous php.pear.dev (#27920) next »