Plain Old Documentation - Sample Pod Document

Sample Pod Document

This document is syntactically correct pod, which attempts to follow the major conventions on section naming as well.

Source HTML result
=head1 NAME podsample - A sample pod document =head1 SYNOPSIS $here->isa(Piece::Of::Code); print <<"END"; This indented block will not be scanned for formatting codes or directives, and spacing will be preserved. END =head1 DESCRIPTION Here's some normal text. It includes text that is B, I, U, and C<$code>-formatted. =head2 An Example List =over 4 =item * This is a bulleted list. =item * Here's another item. =back =begin html Figure 1.

Here's some embedded HTML. In this block I can include images, apply styles, or do anything else I can do with HTML. pod parsers that aren't outputting HTML will completely ignore it.

=end html =head1 SEE ALSO L, L, L. =head1 COPYRIGHT Copyright 2005 J. Random Hacker. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. =cut

Read more about this topic:  Plain Old Documentation

Famous quotes containing the words sample and/or document:

    “All that a city will ever allow you is an angle on it—an oblique, indirect sample of what it contains, or what passes through it; a point of view.”
    —Peter Conrad (b. 1948)

    “... research is never completed ... Around the corner lurks another possibility of interview, another book to read, a courthouse to explore, a document to verify.”
    —Catherine Drinker Bowen (1897–1973)