=begin readme =head1 README ONLY This section will only show up in the README file. =end readme
Delineates a POD section that is only available in README file. If you prefer to include plain text instead, add the text modifier:
Note that placing a colon before the section to indicate that it is POD (e.g. begin :readme) is not supported in this version.
=for readme stop
All POD that follows will not be included in the README, until a continue command occurs:
=for readme include file=filename type=type start=Regexp stop=Regexp =for readme include file=Changes start=^0.09 stop=^0.081 type=text
Includes a plaintext file named filename, starting with the line that contains the start Regexp and ending at the line that begins with the stop Regexp. (The start and stop Regexps are optional: one or both may be omitted.)
Type may be text or pod. If omitted, pod will be assumed.
Quotes may be used when the filename or marks contains spaces:
$parser = Pod::Readme->new( readme_type => "copying" );
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:
testing html xhtml xml docbook rtf man nroff dsr rno latex tex code
You can also use a debug mode to diagnose any problems, such as mistyped format names:
$parser = Pod::Readme->new( debug => 1 );
Warnings will be issued for any ignored formatting commands.
For an example, see the Readme.pm file in this distribution.
See perlpod, perlpodspec and podlators.
Originally by Robert Rothenberg <rrwo at cpan.org>
Now maintained by David Precious <email@example.com>
This module is developed on GitHub at:
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.
|perl v5.20.3||POD::README (3)||2016-03-17|