Re: Feature Request: deeper TOC for pear.php.net manual
| From: | Greg Beaver | Date: | Fri, 02 May 2003 03:15:34 +0000 |
| Subject: | Re: Feature Request: deeper TOC for pear.php.net manual | ||
| References: | 1 2 3 4 | Groups: | php.pear.dev php.pear.doc |
| Request: | Send a blank email to pear-dev+get-15762@lists.php.net to get a copy of this message | ||
Alexander Merz wrote:
Greg Beaver wrote:Thank you, this would be very helpfulThis is not a doc problem - the peardoc categories follows the categories of the package browser. I think you has two problems of understanding: 1.) rendering vs logical structure, as proposed in an early mail, we can provide a toc with a simple package overviewIt would no problem to write, but this is the best way to confuse users.I don't follow you. As a user, I would automatically search for a number manipulation package under "Math." I would look for a number text manipulation package under "Text." I would never think to look for a template engine under "HTML," that is completely illogical. Template
2.) the categories are given by the pear community - if a Template category would exists, it will exists in the manual too.Well, I would like to ask the pear community at large then. In the interest of attracting more users, I'd like to propose a re-organization of all template classes into a new Template category. This would be the first place people looking for a template will look, they may not continue to browse to html. For backwards compatibility, it would be useful to provide a "see new category Templates for all Templates" note in the HTML category documentation, and even a front-page announcement for several months. otherwise, providing a dummy class like: /** * @deprecated version x.0 will drop this compatibility class */ HTML_Template_XXX extends Template_XXX {} will allow code that relies heavily on several mentions of HTML_Template_XXX to work without modification, and let the users know in which version they can expect the change to occur. Regards, Greg