Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

Re: Who's afraid of the manual?

by gmax (Abbot)
on Jan 03, 2002 at 16:04 UTC ( #135969=note: print w/replies, xml ) Need Help??


in reply to Who's afraid of the manual?

In most Unix machines these lines also make you a ready-to-use HTML manual, with a pre-built index.
$ locate DBI.pm $ podselect your_path_to_dbi/DBI.pm | pod2html > DBI.html
podselect and pod2html are part of PodParser, and should come pre-installed with Perl in most flavors of Unix.

update
A shortcut that skips the locate pass, as pointed by Juerd
$ podselect `perldoc -l DBI.pm` | pod2html > DBI.html
_ _ _ _ (_|| | |(_|>< _|

Replies are listed 'Best First'.
Re: Re: Who's afraid of the manual?
by Juerd (Abbot) on Jan 03, 2002 at 16:17 UTC
    A module's path can be found using perldoc -l.

    I like pod2html, thanks.

    Still, I think a ToC should be in every doc, not just html versions

    2;0 juerd@ouranos:~$ perl -e'undef christmas' Segmentation fault 2;139 juerd@ouranos:~$

      The results of pod2html are nice - the program itself is a bit rusty - but that's not my point. I agree that a ToC should be in every doc, but what use is it when running commandline perldoc - you can't click on a chapter in the ToC and jump to it.

      Man, writing documentation is harder than writing the code! I recently designed a website to move some of the example usages OUT of my POD to make the POD more accessible, it was getting very large.

      I must point out my new discovery of CSS (blush). While designing that website, i was determined to not include the POD docs, because the point of the website was hold content not in the docs. However, when trying to link to other CPAN mirror's, i noticed that none of them were as up-to-date as i would like, and most of them did not turn URL's into links.

      So, i ran pod2html on my module and the CSS stylesheets took care of the rest. The result.

      Writing documentation is hard! ;)

      jeffa

      L-LL-L--L-LL-L--L-LL-L--
      -R--R-RR-R--R-RR-R--R-RR
      F--F--F--F--F--F--F--F--
      (the triplet paradiddle)
      

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://135969]
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: (1)
As of 2021-10-22 00:44 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    My first memorable Perl project was:







    Results (85 votes). Check out past polls.

    Notices?