Enhancements for the PEAR manual
| From: | Mark Wiesemann | Date: | Thu, 03 May 2007 14:10:57 +0000 |
| Subject: | Enhancements for the PEAR manual | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-46573@lists.php.net to get a copy of this message | ||
Hi,
I've already tried to get some feedback on the pear-doc list, but I
guess that more people are reading the pear-dev list (that's why I don't
send this to the pear-webmaster list).
We have these two requests for the manual:
http://pear.php.net/bugs/bug.php?id=5350
(link to package info)
http://pear.php.net/bugs/bug.php?id=9463
(clean-up for sidebar)
Because we currently have nobody that can edit the DSSSL stylesheets,
because the transition to XSLT stylesheet might take some more time,
and because the sidebar of the manual is built by some PHP code anyway,
I have prepared a patch. The result can be seen in this screenshot:
http://www.markwiesemann.eu/tmp/pear-manual5.png
Compared with the current page on pear.php.net,
http://pear.php.net/manual/en/package.html.html-quickform.html-quickform-element.getvalue.php,
there are three differences:
- package/class names are removed from the method names in the left
sidebar, and the methods are indented per class (try yourself: who would
spot the HTML_QF_input class links on the current page?)
- below the "Download Documentation" link on the left, there are two new
links: "Package Info" (/packages/HTML_QuickForm) and "API Documentation"
(/packages/HTML_QuickForm/docs/latest/)
(if no package documentation is viewed, but e.g. the Coding Standards,
these two links are not visible)
- below these two links the normal navigation bar ("Main",
"Documentation" etc.) is shown; currently it is just suppressed, but I
would say that this bar is very useful and makes navigation easier and
more consistent through the whole website
If anybody has an opinion on one or more of these three changes, then
please share them.
Regards,
Mark
--
http://www.markwiesemann.eu