This is not really a Perl question, but the monastery is good place to ask. ;)

I'm looking for a good and simple format for documentation. Actually is for wxWindows, we are looking for a standart format for the documentation, but it need to be simple and integrated with the API.

The format need to be simple, like POD, to everyone be able to write it fast. And need to handle C/C++ codes, since this is for C++ classes.

Now the wxWindows documentation is based on Latex, that is converted to HTML (and other formats). But the Latex format isn't simple, is hard like HTML (compared to POD). The idea is to also have a format easy to extract information by other programs (or at least be able to convert it easy to a XML base).

I was thinking in POD, but there is better ways?

If I'm not wrong, Perl6 won't use POD. What format Perl6 will use?

I will be glad if some monks list the documentation formats that they know (with some explanation/examples). ;-P

Graciliano M. P.
"The creativity is the expression of the liberty".

In reply to What's the best plain Documentation format? by gmpassos

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!
  • 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, details, 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, summary, 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.