I beg to differ about "not caring". Using the exact style sheet as CPAN probably isn't important, but making sure you have an idea of how the pod is being parsed is important.

It isn't so easy to read the text version of the pod file and be certain that you have all of your pod tags in the right place and properly formatted. Looking at an HTML rendering provides important and easy to assess visual feedback on your pod tagging. I make mistakes all the time, especially when I'm nesting tags, using unfamiliar pod syntax, or linking to external material. The documentation of pod syntax also isn't always 100% and it is necessary to experiment a bit before one has the right syntax. Broken links are another matter that is hard to assess merely by reading the pod file.

You can get a rough idea of how the HTML will look by using the pod2html program. At the minimum it will help you identify syntax errors, misplaced tags, and broken links.

Best, beth


In reply to Re: how POD will look on CPAN by ELISHEVA
in thread how POD will look on CPAN by spx2

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.