Notes for authors

Notes on structure

Here are the formatting conventions:

  1. Start your document with a "=head1" section

  2. Use as many "=head2" headings as you need

  3. Finish the document with: "=cut"

  4. Module and variable names should be marked up as: C<name>

  5. perl should be spelled Perl ;-)

  6. Code samples must be indented

  7. If a code sample happens not to start with a hash bang line, it
     should be marked up with a single:  <CODE>

  4. Output samples must be indented

  9. Try to add a See Also section at the end, referring to other
     perldoc entries if possible

A sample POD file

Download the sample file