I'm in the process of documenting a project I've been working on - pity on me for not having done so earlier! Whatever... I have a bunch of modules (in a common subdirectory) almost all of which use a certain dirty hack which does work, but is completely unsatisfactory and will be better removed to avoid possible future clashes and inconveniences.

Now, I'm including in all of these docs a TODO section and as far as the dirty hack issue goes, I'd like to factor out a common piece of POD warning about it, and "include" it like I could do for code with do 'file'. Maybe I'm just missing something obvious, but I can't find anything in the documentation.

Alternatively I may just write a separate file, say todo.pod and point to it it in the SEE ALSO section and possibly elsewhere, to stress the concept. But I'd really prefer something along the lines of an "inclusion" in situ. Any idea?


In reply to A common piece of POD by blazar

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.