My code contains POD to provide first-level documentation (higher-level is in tech documents under text processor).

For instance, I use =over, =item 1 ..., =back to describe arguments to functions.

Sometimes, I insert notes or remarks about what could be otherwise difficult to understand at first sight. My structure is:

Notes:
=over
=item
Text of the note
=back

[download]

Please note that the =item stuff is empty because, in this case, I don't like the default bold rendering of the "title" item line.

This POD is translated into HTML through pod2html. Browsers display it as intended.

Now I want these HTML pages to look like the rest of the web site, i.e. I want to add headers, fancy titles and footers, plus various links. This is a sugar job for XML::Parser. But it complains about mismatched tags.

I have traced it back to my empty =item line which is translated as a single <dt> without closing </dt> tag.

Translation is correct when =item stuff is not empty.

Is my =item usage forbidden by POD rules?

Can this be corrected in pod2html?

In the meantime, how can I workaround this shortcoming?

Thanks for the tips.

In reply to POD translation to HTML bug? by ajl52

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.