Pod::Weaver::Section::Region - find a region and put its contents in place where desired
This section will find and include a located hunk of Pod. In general, it will find a region with the specified name, such as:
=begin :myfoo =head1 More Pod Here =end :myfoo
In other words, if your configuration include:
[Region] region_name = myfoo
...then this weaver will look for "=begin :myfoo" ( and "=for :myfoo" and... ) and include it at the appropriate location in your output.
Since you'll probably want to use Region several times, and that will require giving each use a unique name, you can omit
region_name if you provide a plugin name, and it will default to the plugin name. In other words, the configuration above could be specified just as:
[Region / myfoo]
required attribute is given, and true, then an exception will be raised if this region can't be found.
A boolean value specifying whether this region is required to be present or not. Defaults to false.
If it's enabled and the region can't be found an exception will be raised.
The name of this region. Defaults to the plugin name.
A boolean value specifying whether nonpod regions are allowed or not. Defaults to false.
nonpod regions are regions without a
: prefix as explained in perlpodspec
# region_name = myregion # is_pod = false =begin myregion # region_name = myregion # is_pod = true =begin :myregion
A boolean value specifying whether the region's contents should be flattened or not. Defaults to true.
#unflattened =begin :myregion =head1 =end :myregion #flattened =head1
Ricardo SIGNES <email@example.com>
This software is copyright (c) 2014 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.