Codex

Pod::Readme

Section: User Contributed Perl Documentation (3pm)

Updated: 2010-12-09

Index?action=index Return to Main Contents


NAME

Pod::Readme - Convert POD to README file

SYNOPSIS

DESCRIPTION

This module is a subclass of Pod::PlainText which provides additional POD markup for generating README files.

Why should one bother with this? One can simply use

A problem with doing that is that the default pod2text converter will add text to links, so that ``L<Module> is translated to ``the Module manpage.

Another problem is that the README includes the entirety of the module documentation! Most people browsing the README file do not need all of this information.

Likewise, including installation and requirement information in the module documentation is not necessary either, since the module is already installed.

This module allows authors to mark portions of the POD to be included only in, or to be excluded from the README file. It also allows you to include portions of another file (such as a separate ChangeLog).

Markup

Special POD markup options are described below:

begin/end
Delineates a POD section that is only available in README file. If you prefer to include plain text instead, add the modifier:
Note that placing a colon before the section to indicate that it is POD (e.g. ) is not supported in this version.

:

stop/continue
All POD that follows will not be included in the README, until a command occurs:
:
include
Includes a plaintext file named filename, starting with the line that contains the start and ending at the line that begins with the stop . (The start and stop Regexps are optional: one or both may be omitted.)
Type may be or . If omitted, will be assumed.

Quotes may be used when the filename or marks contains spaces:

:

One can also using maintain multiple file types (such as including TODO, or COPYING) by using a modified constructor:

In the above ``Markup commands replace ``readme with the tag specified instead (such as ``copying''):

As of version 0.03 you can specify multiple sections by separating them with a comma:

There is also no standard list of type names. Some names might be recognized by other POD processors (such as ``testing or ``html). Pod::Readme will reject the following ``known'' type names when they are specified in the constructor:

You can also use a ``debug'' mode to diagnose any problems, such as mistyped format names:

Warnings will be issued for any ignored formatting commands.

Example

For an example, see the Readme.pm file in this distribution.

SEE ALSO

See perlpod, perlpodspec and podlators.

AUTHOR

Originally by Robert Rothenberg <rrwo at cpan.org>

Now maintained by David Precious <[email protected]>

Suggestions, Bug Reporting and Contributing

This module is developed on GitHub at:

http://github.com/bigpresh/Pod-Readme

LICENSE

Copyright (c) 2005,2006 Robert Rothenberg. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Some portions are based on Pod::PlainText 2.02.


Index

NAME

SYNOPSIS

DESCRIPTION

Markup

Example

SEE ALSO

AUTHOR

Suggestions, Bug Reporting and Contributing

LICENSE