Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number
 
PerlMonks  

Re: Pod::Master

by mojotoad (Monsignor)
on Nov 07, 2002 at 14:54 UTC ( #211085=note: print w/ replies, xml ) Need Help??


in reply to Pod::Master

Nice work!

I have a minor layout issue; perhaps it's just how my brain works. In the one-shot module description, I'd consider putting the NAME/description up at the top, above the TOC. It shouldn't add so much space that the TOC is pushed off the bottom of the page; with the unnamed TOC on top I had to scramble around with my eyes a bit to find the name of the module. Perhaps just an extra blurb at the top of the TOC would suffice, in addition to a NAME section.

Also, in your example POD for Pod::Master, I see no DEPENDENCIES section. Will this be handled in a generic POD way, or will it take advantage of that nifty INSTALLED MODULES format?

Again, nice work.
Matt


Comment on Re: Pod::Master
Re: Re: Pod::Master
by PodMaster (Abbot) on Nov 07, 2002 at 17:45 UTC
    Thanks!.

    Oh yeah, I switched SYNOPSIS/DESCRIPTION, d'oh ;)

    And the 2nd d'oh, I generated that page by hand , without the --header option, here's what it really looks like by default (d'oh).

    Now, I am not subclassing Pod::Html, so whatever Pod::Html does, it does on its own (i myself like the toc)

    What does Will this be handled in a generic POD way, or will it take advantage of that nifty INSTALLED MODULES format? mean?

    What is a "generic POD way"? And how would I take advantage of "that nifty INSTALLED MODULES format?"

    I kind of think DEPENDENCIES belong in the README/Makefile.PL, so that's why I didn't put it in the pod.

    I'm pretty satisfied with Pod::Html and I don't plan on re-inventing it any time soon (i'm satisfied in writing patches ;)

    ____________________________________________________
    ** The Third rule of perl club is a statement of fact: pod is sexy.

      Don't get me wrong, I like the TOC as well -- it was just an issue of visually locating the name of the module immediately.

      By generic POD I just meant normal =head1 plus either items or a comma-separated list of dependencies. It wasn't really a clearly thought-out question, but it seemed you had more going on with the code that generated the INSTALLED MODULES than merely POD parsing. I guess I'm secretly desiring some tool, other than perl -c, that will recursively trace dependencies and present them in an outline format.

      You are right that lots of modules do indeed put the dependencies in README/Makefile.PL (as well as perhaps POD). A dependency-sniffer would no doubt get tripped up on optional dynamic dependencies as well. :(

      Matt

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://211085]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others drinking their drinks and smoking their pipes about the Monastery: (4)
As of 2015-07-04 13:14 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









    Results (60 votes), past polls