Changing manual order

From: Date: Wed, 24 Apr 2002 15:16:19 +0000
Subject: Changing manual order
Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-5778@lists.php.net to get a copy of this message
While thinking about documentating new packages and automatical adding manual pages to a package archive, i ran into a lot of trouble. The problem is the dividing of the manual into a core and a package section. I wanted to write docs about HTTP_Post and HTTP_Request.This packages are not installer related and will not be pre-installed. Normaly i would add the docs to the package section. But we have already a HTTP part in core. So we would have two HTTP sections in the manual and every non-'pear-dev[il]' would ask why and forces him to lookup twice to find docs for a spec. package. (BTW: The stuff in core/HTTP isn't installer related too) So i propose the following: - Core is for the PEAR_* class - the rest goes into Packages, independent of required by installer or not. Every Package gets an own reference page and every package function has an own refentry. Core PEAR PEAR_Common PEAR_Error ... Package Archive_Tar Auth Auth_HTTP ... PECL Packages ... This structure is easy to use and to write, and a pearman tool wouldn't be a mess.

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