I'm looking at enhancing my POD with examples that are tested (using any of POD::Tested, Test::Pod::Snippets, or Test::Inline) so I know they run and do what they are documented to do.

Thing is, some tests also want input files, and I also want to show the example files in the POD while being sure the tested file contents match.

Is there already in CPAN some way of embedding several different sample files in POD, with a processor to create them in a given directory? Or conversely, an easy way to include the contents of a file from my t/sample-data/ directory in my POD?

Simpler the better. This is for internal use, smallish modules and scripts. For example I respect RJBS' POD::Weaver, POD::Elemental but think they are too much for me and this project. I'm trying to improve upon example-file copy/paste with something nearly as simple.

In reply to Extracting/embedding sample files in POD by Yary

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.