Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
I've used POD as documentation. I've used HTML as documentation. I've used *roff as documentation. I've used LaTeX as documentation. I've used PDF as documentation. I still use the latter if I need to write something for a customer and it needs to look "fancy" (I write it in LaTeX, and translate the dvi to PDF).

But nowadays, I swear by plain ASCII documents. It's the only true platform independent format (yeah, there are non-ASCII platforms out there). Anyone can read it. Anyone can edit it. And just before you think "plain ASCII sucks, I need markup/images/whatever", realize that RFCs have been written in plain ASCII for more than 3 decades, and will be written in plain ASCII for quite some time. I can read RFC 1 (which was written in 1969 and contains "images") as easily as the newest RFC.

Plain ASCII rocks.

Abigail


In reply to Re: POD as a general documentation system by Abigail-II
in thread POD as a general documentation system by robartes

Title:
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!
  • 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?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others perusing the Monastery: (19)
    As of 2015-07-01 20:16 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









      Results (19 votes), past polls