Module Design and Implementation
Explicit Formatting
If you ever need to add some explicit formatting for a particular formatter, you can
use =begin and =end. For example, to add an HTML table that will only show up
when the POD is translated into HTML, do the following:
=begin html
=end html
You can add explicit formatting instructions for any POD formatter by using
the appropriate format identifier. For example, to add special formatting for the
pod2man formatter that translates POD into UNIX manual page format, you would
use a =begin man command. These identifiers (html, man, and so on) are usually easy
enough to guess, but you can also determine the identifier for a particular trans
lator by reading its documentation.
That's all there is to it.
4
For the most part writing POD is no more difficult than
writing comments you rarely need to worry about formatting unless that sort of
thing makes you happy. This is the key to its success; getting lazy programmers like us
to write documentation is hard enough, so the format has to be as simple as possible.
Where to Start
Now that you have the tools for the job, you're ready to start designing your
module. Start with a general description of what the module will do. Try to focus
on what not how at this stage. Here's an example of a good description:
=head1 DESCRIPTION
This module will provide an interface to the BOA SETI satelite. It
provides functions to send signals to distant star systems as well as
functions to retrieve responses.
4. With some minor exceptions. See the perlpod documentation for the other 10 percent of POD
that takes up 90 percent of the manual.
71
71
footer
Our partners:
PHP: Hypertext Preprocessor Best Web Hosting
Java Web Hosting
Inexpensive Web Hosting
Jsp Web Hosting
Cheapest Web Hosting
Jsp Hosting
Cheap Hosting
Visionwebhosting.net Business web hosting division of Web
Design Plus. All rights reserved