Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Re: Creating Books and Manuals with Perl

by Aristotle (Chancellor)
on Sep 10, 2002 at 10:02 UTC ( [id://196601]=note: print w/replies, xml ) Need Help??


in reply to Creating Books and Manuals with Perl

I think POD is an excellent choice for the task. It was perfectly sufficient for Camel 3 to be written in it, after all; a perfect flyweight markup language for documentation or technical literature. You can embed sequences of foreign markup with the =for directive; for example have a =for html passage that contains a link to an image. There are many, often highly configurable pod2* scripts. Want to have it in actual print? pod2latex will do the job. No need to even mention pod2html. If none of those suit your needs you can roll your own f.ex by throwing POD::Parser and Template Toolkit 2 at the problem for minimum effort and maximum flexibility.

What I love about POD is that it is very basic yet provides all the essential directives: the resulting documents are fully indexable. Formatting directives are reduced to the minimum required, so they translate well to any destination media regardless of what it is.

I would definitely not want to write documentation in XML. That markup language is, IMO, not for human consumption.

POD is underappreciated in my opinion. Quoth podmaster's sig: POD is sexy. ;^)

Makeshifts last the longest.

  • Comment on Re: Creating Books and Manuals with Perl

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others surveying the Monastery: (3)
As of 2025-07-18 13:28 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?
    erzuuliAnonymous Monks are no longer allowed to use Super Search, due to an excessive use of this resource by robots.