Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

Re: Re: POD as a general documentation system

by Juerd (Abbot)
on Mar 27, 2003 at 07:52 UTC ( #246176=note: print w/ replies, xml ) Need Help??


in reply to Re: POD as a general documentation system
in thread POD as a general documentation system

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

"images"

I like POD's verbatim paragraphs :)

Juerd
- http://juerd.nl/
- spamcollector_perlmonks@juerd.nl (do not use).


Comment on Re: Re: POD as a general documentation system
I'll second that
by g00n (Hermit) on Mar 28, 2003 at 04:47 UTC
    "...Yes, plain ASCII rocks. But one of the beauties of POD is that it is so easy to convert..."

    I'll second that. I have often been tempted by complex markup languages until I came across Stas Beckmans site (stason.org) after attending a local pm about the upcoming Mod_Perl 2.

    All the documentation was available simultaneously in printable PDF (see the top RH icons) and viewable online via html and in Perl itself. For those that are interested it is processed using docset, Pod::HtmlPsPdf etc.

    And all editable via POD.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (15)
As of 2014-07-10 17:03 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    When choosing user names for websites, I prefer to use:








    Results (213 votes), past polls