|Just another Perl shrine|
Re: Re: POD as a general documentation systemby Juerd (Abbot)
|on Mar 27, 2003 at 07:52 UTC||Need Help??|
Plain ASCII rocks.
Yes, plain ASCII rocks. But one of the beauties of POD is that it is so easy to convert.
POD is easier to write than plain ASCII documentation, if you want the same features. Although I don't use images in my documentation, I do use definition lists. POD makes creating a definition list very easy.
And when I'm done, I pod2text my document. But I can also pod2html and put it on my website with nice markup.
Anyone can read it.
Anyone can read pod2text's output
Anyone can edit it.
If someone is uncapable of editing POD, that someone is VERY stupid.
You don't have to learn anything before you can edit plain text. Or do you? Is indenting done with tabs or spaces? Do we use 72, 78, 80 or 40 characters per line? Or do we think of lines as paragraphs, and let the pager do the wrapping? How are lists layed out?
With POD, it's much easier to have a consistently layed out document
I like POD's verbatim paragraphs :)