in reply to How perldoc chooses PODs' path

Why don’t you just call pod2text directly? That way you know exactly what it’s doing.

Replies are listed 'Best First'.
Re^2: How perldoc chooses PODs' path
by LanX (Saint) on Mar 01, 2012 at 22:33 UTC
    Sure I can do whatever I want. :)

    The idea is that for end users file.pod has priority over file.pl or file.pm.

    Like that file.pod can be flexibly generated out of (pseudo-)POD directives in file.pl

    Motivation:

    There is a long going discussion if POD should be inter-weaved with code or not, with good arguments for both sides.

    For instance the order of subroutines/methods in the source isn't necessarily the best order for documentation.

    And "private" subs shouldn't be documented at all.

    Generating file.pod in a way reflecting these needs could be a handy solution, w/o forcing anybody to use anything else than classical perlpod.

    Cheers Rolf

[reply]
      Generating file.pod in a way reflecting these needs could be a handy solution, w/o forcing anybody to use anything else than classical perlpod.
      I’m afraid you’ve lost me there. I suppose I do occasionally use pod2text, usually on a exact pathname, sometimes in conjunction with pmpath to find a module path. Isn’t pod2text the classic program here? Why bother with anything else?

      I honestly can’t think of any reason (apart from being trapped on Windows, I suppose) why anyone would use anything but the normal man program for reading Perl documentation. Occasionally I create PDF or HTML, but those are pretty special-purposed.

      I have a bunch of little tools for dealing with modules and with pod. Here’s a partial list: balance-angles, balance-braces, balance-brackets, balance-parens, balanced, basepods, catpod, catpodidx, faqpods, fmtpara, idxspell, modpods, okpod, ora2pod, orphanX, pmall, pmcat, pmdesc, pmdirs, pmeter, pmeth, pmexp, pmfunc, pminst, pmload, pmls, pmman, pmpath, pmvers, pod2docbook, pod2ora, podcode, podgrep, podpath, pods, podtoc, shflpod, sitepods, splitpod, stdpods, testpod, uniwc, xfootnotes, and xpod — just to name a few.

      Here’s an illustration of the way I mix and match just a few of the more frequently used ones:

      Read more... (14 kB)
      But for just reading things, I always use pod2text on uninstalled things and man on installed things. Anything else just gets in my way — but your mileage may vary, especially if you’ve been metricated. 😈
[reply]
[d/l]
        Your pmtools are really nice! (Especially for analyzing PMs and PODs).

        Thanks for showing me! :)

        But my aim is rather to have an easier (and more DRY) way to author POD (and BTW docstrings for introspection)

        Cheers Rolf

[reply]
        I honestly can’t think of any reason (apart from being trapped on Windows, I suppose) why anyone would use anything but the normal man program for reading Perl documentation.

        And I honestly cannot think of any reason (apart from the living nightmare of Life on Mars ) why anyone would use man. Or perldoc. Or POD for that matter.

        Hey. Perhaps there is a market for a new website: say, TWinders.com. It'd be like Twitter, but use smoke signals for the last mile. For all those ol'fogies out there than can't bring themselves to move beyond the golden days of their youth.

        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?
[reply]
[d/l]

In Section Seekers of Perl Wisdom