Am Mittwoch, 21. Januar 2004 00:11 schrieb Stas Bekman:
translated to mp2 this may look like
Apache::Request(Rec|Handle) request record accessors Apache::RequestIO Discription of IO methods of Apache::RequestRec Apache::Request::* bla bla bla
I hope the spaces are correct in your mailers. Just to be sure Apache::RequestIO and Apache::Request::* are indented.
We have that already accomplished more or less. May be some more polishing is needed.
but it doesn't quite follow your previous suggestion that you should be able to find *all* Apache::RequestRec object's methods in the manpage.
I want this yes, I use perldoc X::Y and then / to search for my needs that works fine also on very large pages. But if the file is to big for that, I be content with a description like the above.
Perhaps like this:
First a overview what the package is good for. Followed by the groups where the detailed discription of each method is found. And a part where *every* method is listed by name and one line discription and again where it is documented. The key for me is that at least *all* methods for the Apache::RequestRec are listed. At least with a pointer to the document.
That's similar to what I suggested, but it's not very effective. If you go through the effort of doing all that, won't it be much faster to execute:
lookup foo
and it'll tell you which doc to look at? For the online docs we could just have one huge index of all methods with xrefs to the right manpages.
In fact talking about command line utils, since we already have a utility mp2doc, which is needed to deal with Apache2/ subdirectory where the normal perldoc won't look for, I can't think why can't we plug the magical do-all lookup method which will find the right manpage for you:
mp2doc -f content_type
ala perldoc -f, though may be using a different flag, or no flag at all (it can magically figure out whether it's a method or a package name.
though I'm not sure what to do with methods which have different implementation in different classes. e.g.:
mp2doc -f read
read() has 3 different manpages, which one should we show? of course if you tell:
mp2doc Apache::RequestRec read
then it'll know that you are after Apache::RequestIO.
it's possible that we will need to have different solutions for command line and web utils, unless we throw all methods into one manpage.
...just brainstorming aloud here, throw your ideas please ...
__________________________________________________________________ Stas Bekman JAm_pH ------> Just Another mod_perl Hacker http://stason.org/ mod_perl Guide ---> http://perl.apache.org mailto:[EMAIL PROTECTED] http://use.perl.org http://apacheweek.com http://modperlbook.org http://apache.org http://ticketmaster.com
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
