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

(jeffa) 3Re: Who's afraid of the manual?

by jeffa (Bishop)
on Jan 03, 2002 at 23:39 UTC ( #136058=note: print w/replies, xml ) Need Help??


in reply to Re: Re: Who's afraid of the manual?
in thread Who's afraid of the manual?

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)
  • Comment on (jeffa) 3Re: Who's afraid of the manual?

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others scrutinizing the Monastery: (4)
As of 2021-10-21 19:15 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    My first memorable Perl project was:







    Results (83 votes). Check out past polls.

    Notices?