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:

    “The present war having so long cut off all communication with Great-Britain, we are not able to make a fair estimate of the state of science in that country. The spirit in which she wages war is the only sample before our eyes, and that does not seem the legitimate offspring either of science or of civilization.”
    —Thomas Jefferson (1743–1826)

    “What is a diary as a rule? A document useful to the person who keeps it, dull to the contempory who reads it, invaluable to the student, centuries afterwards, who treasures it!”
    —Ellen Terry (1848–1928)