The podchecker program (supplied as part of the most recent distributions) will take a Perl / POD source file and check the POD syntax for you:
$ podchecker pod1
pod1 pod syntax OK.
$ podchecker re-ask
re-ask does not contain any pod commands.
$ podchecker pod2
WARNING: =item type mismatch ('bullet' vs. 'definition') at line 23 in file pod2
pod2 pod syntax OK.
$
Podchecker will check multiple files at the same time, and has a -nowarnings option if you only want errors to be flagged.
COMMON POD PITFALLS
Pod translators usually will require paragraphs to be separated by completely empty lines. If you have an apparently empty line with some spaces on it, this can cause odd formatting.
Translators will mostly add wording around a L<> link, so that L<foo(1)> becomes "the foo(1) manpage", for example (see pod2man for details). Thus, you shouldn't write things like the L<foo> manpage, if you want the translated document to read sensibly
See also
POD training notes and further examples
Please note that articles in this section of our
web site were current and correct to the best of our ability when published,
but by the nature of our business may go out of date quite quickly. The
quoting of a price, contract term or any other information in this area of
our website is NOT an offer to supply now on those terms - please check
back via
our main web site
Perl - Plain Old Documentation [242] - ()
[668] - ()
[760] - ()
resource index - Perl
Solutions centre home page
You'll find shorter technical items at
The Horse's Mouth and
delegate's questions answered at
the
Opentalk forum.
At Well House Consultants, we provide
training courses on
subjects such as Ruby, Lua, Perl, Python, Linux, C, C++,
Tcl/Tk, Tomcat, PHP and MySQL. We're asked (and answer)
many questions, and answers to those which are of general
interest are published in this area of our site.