Ricardo SIGNES > Pod-Weaver-4.005 > Pod::Weaver::Section::Generic

Download:
Pod-Weaver-4.005.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 4.005   Source   Latest Release: Pod-Weaver-4.006

NAME ^

Pod::Weaver::Section::Generic - a generic section, found by lifting sections

VERSION ^

version 4.005

OVERVIEW ^

This section will find and include a located hunk of Pod. In general, it will find a =head1 command with a content of the plugin's name.

In other words, if your configuration include:

  [Generic]
  header = OVERVIEW

...then this weaver will look for "=head1 OVERVIEW" and include it at the appropriate location in your output.

Since you'll probably want to use Generic several times, and that will require giving each use a unique name, you can omit header 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:

  [Generic / OVERVIEW]

If the required attribute is given, and true, then an exception will be raised if this section can't be found.

ATTRIBUTES ^

required

A boolean value specifying whether this section is required to be present or not. Defaults to false.

If it's enabled and the section can't be found an exception will be raised.

header

The name of this section. Defaults to the plugin name.

AUTHOR ^

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 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.

syntax highlighting: