Beefy Boxes and Bandwidth Generously Provided by pair Networks
laziness, impatience, and hubris

Comment on

( #3333=superdoc: print w/replies, xml ) 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 :)

- (do not use).

In reply to Re: Re: POD as a general documentation system by Juerd
in thread POD as a general documentation system by robartes

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?

    What's my password?
    Create A New User
    and all is quiet...

    How do I use this? | Other CB clients
    Other Users?
    Others browsing the Monastery: (8)
    As of 2018-07-20 20:35 GMT
    Find Nodes?
      Voting Booth?
      It has been suggested to rename Perl 6 in order to boost its marketing potential. Which name would you prefer?

      Results (441 votes). Check out past polls.