Re: cvs: peardoc / manual.xml.in
| From: | Alan Knowles | Date: | Fri, 12 Jul 2002 04:36:36 +0000 |
| Subject: | Re: cvs: peardoc / manual.xml.in | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-7673@lists.php.net to get a copy of this message | ||
I was looking at the adding of the db_dataobject manual - and discovered that it doesn't really fit well in with the current structure of the manual -or probably that I've no idea what I'm doing with docbook :)
at present the package section is roughly broken up into top level groups something like this:
Group of Packages: &packages.authentication;
Single Packages: &packages.database.db-dataobject; Group of Packages: &packages.file; Single Packages?: &packages.log;Group of Packages: &packages.networking; Group of Packages: &packages.templates;
Single Packages: &packages.phpdoc; Single Package: &packages.phpunit; Group of Packages: &packages.xml;The group of packages usually lists sub packages - eg. Net_Curl.. which has a single page (in the HTML version), describing the class and methods. The Single Package - tend to be a more detailed (eg. with subsections) describing different areas about that package. I have to admit I've got no great ideas on doing it any better - eg. to me the default (grouping method) ends up with a not so great manual page - eg. all on one big page. - see the Integrated Template manual for an example. - this could be grouped and made alot more comprehinsive... I guess the other issue is how the title's relate to the packages - has anyone been looking at this? - or at least got a few good comments... regards alan Alan Knowles wrote:
alan_k Fri Jul 12 00:26:20 2002 EDTModified files: /peardoc manual.xml.in Log:adding db databobject to manual - will post on pear-dev about issues with this Index: peardoc/manual.xml.in diff -u peardoc/manual.xml.in:1.27 peardoc/manual.xml.in:1.28 --- peardoc/manual.xml.in:1.27 Thu Apr 11 05:35:02 2002 +++ peardoc/manual.xml.in Fri Jul 12 00:26:20 2002 @@ -50,6 +50,7 @@ <part id="packages"> <title>&Packages;</title> &packages.authentication; + &packages.database.db-dataobject; &packages.file; &packages.log; &packages.networking;