dspman has asked for the wisdom of the Perl Monks concerning the following question:
|
|---|
| Replies are listed 'Best First'. | |
|---|---|
|
Re: Perl Module Documentation
by RichardK (Parson) on Dec 20, 2011 at 17:48 UTC | |
I think Pod::Webserver will do want you want | [reply] |
|
Re: Perl Module Documentation
by Khen1950fx (Canon) on Dec 21, 2011 at 06:34 UTC | |
I think that I found it... I have over 20,000 modules, so it took a half-hour to get all the info, and it took another ten minutes to display on Firefox.
| [reply] [d/l] |
|
Re: Perl Module Documentation
by kevbot (Vicar) on Dec 21, 2011 at 04:44 UTC | |
The Perl Advent Calendar has a nice article about Perldoc::Server, "All Your Documentation - Even Offline". I don't know if it installs easily on Strawberry Perl. I installed it on my Mac yesterday, but I had to work my way around a bug in a dependency, Package::Stash::XS. The resulting documentation is a nicely formatted web page. | [reply] |
|
Re: Perl Module Documentation
by ww (Archbishop) on Dec 20, 2011 at 17:25 UTC | |
| [reply] [d/l] |
by BrowserUk (Patriarch) on Dec 20, 2011 at 18:12 UTC | |
Does your perldoc help output show you options that mine doesn't? Cos I don't see anything there that suggests it converts installed module POD to an AS-style HTML treeview:
With the rise and rise of 'Social' network sites: 'Computers are making people easier to use everyday'
Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
"Science is about questioning the status quo. Questioning authority".
In the absence of evidence, opinion is indistinguishable from prejudice.
| [reply] [d/l] |
by BrowserUk (Patriarch) on Dec 20, 2011 at 19:32 UTC | |
Via /msg: ww says Re Re^2: Perl Module Documentation -d -T -o and note carefully that I said "starting point" -- NOT, here's a script to do the conversion Those options certainly did not stand out to me as a mechanism by which the OPs question could be solved. And even now you pointed them out I still wouldn't have a clue how to use them to solve his problem. Perhaps you would consider supplying a little more info on how to go about it? I asked because I would very much like to know how to do this. I have and use daily, minute by minute, the AS HTML treeview built by AS. But: So you see. My question was not an idle one, but actually an attempt to illicit further info on how to go about this. The said. RTFM replies are only really useful if the information asked for is there and obvious and likely to be both recognised and understood by the OP. And despite the time I've been around Perl, your post did not help me answer the question. With the rise and rise of 'Social' network sites: 'Computers are making people easier to use everyday'
Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
"Science is about questioning the status quo. Questioning authority".
In the absence of evidence, opinion is indistinguishable from prejudice.
| [reply] [d/l] [select] |
by ww (Archbishop) on Dec 20, 2011 at 20:45 UTC | |
The options I mentioned allow you to selectively produce a plain text file (formatted with spaces and newlines) of the relevant doc (and pod, TBOMK) using a CLI command like this (under Win):
The -d argument is the outfile name; -T says "don't page" and -o can specify a format, but is not something I've played with seriously. (Note, NO hyphen before the "f" preceding the function name. I have no clue why it works that way.) From there, wrap the output in minimal html,
However, automating the above in a script may be more work than I've considered. Making the .html 'semantic' would certainly be more work. So, in all honesty (/me flushes with pseudo-embarassment and pride at his self-congratulatory caveat), RichardK's pointer to Pod::Webserver now seems likely to be a far better way to do the job, unless it's bug-ridden. And in further honesty, you're right about needing to be obvious -- I just thought it would be to a Monk as experienced and wise (if sometimes, a tad sharp with others) as you. But since the post will stand for others, apologies, also, for failing to follow that guidance. But, afterthought, would you please stick <c>readmore<c>s in there somewhere? | [reply] [d/l] [select] |
by BrowserUk (Patriarch) on Dec 20, 2011 at 21:03 UTC | |
|
Re: Perl Module Documentation
by keszler (Priest) on Dec 20, 2011 at 17:43 UTC | |
...read that switch backwards... | [reply] [d/l] |