in reply to Re: Perl Module Documentation
in thread Perl Module Documentation

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:

  1. it only includes modules installed by PPM, not those I build/install via other mechanisms;
  2. it includes POD for a whole bunch of stuff from the AS & standard distribution that I'm not interested in and would like to exclude.

    Eg. I Have no use for this lot:

    Or this junk:

    Or this stuff:

  3. and it includes whole heaps of stuff from some modules that I would like to exclude.

    Eg. This junk from Date::Manip

    And this from somewhat similar crap from DateTime :

    And there's more. Much, much more!

  4. I can manually trim these out, but the next time I install a module with PPM, it rebuilds it all and everything reappears. I would really like to find a way to produce an HTML doc stack of just the bits of POD that I find useful.

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.

The start of some sanity?

Replies are listed 'Best First'.
Re^3: Perl Module Documentation
by ww (Archbishop) on Dec 20, 2011 at 20:45 UTC
    Sorry; I thought you were gratuitously "bustin' my chops;" I see differently now and apologize for the deficiencies in my reply. They were numerous.

    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):

    F:\pl_docs>perldoc -d nextpod.out -T -o f next Perldoc (Pod::Perldoc::ToText) output saved to nextpod.out

    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,

    html <head> <title> <!-- (module or function title) --> </title> </head> <body> <pre> <!-- (content of your output from above, verbatim) --> </pre> </body> </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?

      But, afterthought, would you please stick readmores in there somewhere?

      As all the long stuff is wrapped in <spoiler> tags, you should not be seeing any of it unless you explicitly click one of the links in: <Reveal this spoiler or all spoilers in this node or all in this thread>.

      Whereas, if I had used <readmore>'s, everyone would have to suffer it all as soon as they opened the post.


      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.

      The start of some sanity?