=pod

=for comment
DO NOT EDIT. This Pod was generated by Swim v0.1.35.
See http://github.com/ingydotnet/swim-pm#readme

=encoding utf8

=head1 NAME

Swim::Plugin::cpan - Swim CPAN Head/Tail Support

=for html
<a href="https://travis-ci.org/ingydotnet/swim-plugin-cpan-pm"><img src="https://travis-ci.org/ingydotnet/swim-plugin-cpan-pm.png" alt="swim-plugin-cpan-pm"></a>

=head1 VERSION

This document describes L<Swim::Plugin::cpan> version B<0.0.6>.
";

=head1 SYNOPSIS

In your C<.swim> file:

    <<<cpan-head>>>

    ... Swim CPAN doc content ...

    <<<cpan-tail>>>

From the command line:

    swim --to=pod --meta=Meta doc/MyModule.swim

=head1 DESCRIPTION

This Swim plugin will generate the head and tail of your pod files from a
metadata file.

=head1 SWIM FUNCTIONS

This plugin provides 2 block level functions:

=over

=item `>>

The C<cpan-head> function adds a C<name>, C<badge> and C<version> section
(in that order) to your document using metadata variables. By default you
get a C<NAME> section and a C<VERSION> section. You get a badge section if
your metadata has a C<badge> key. You can specify the section names you want
like this:

    <<<cpan-head name version>>>

You can request a section not be used like this:

    <<<cpan-head -version>>>

=item `>>

The C<cpan-tail> function adds a C<see>, C<author> and C<copyright> section
(in that order) to your document using metadata variables. By default you get
a C<AUTHOR> section and a C<COPYRIGHT AND LICENSE> section. You can request a
'SEE ALSO' section if your metadata has a C<see> key. You can specify the
section names you want like this:

    <<<cpan-tail see author copyright>>>

You can request a section be added like this:

    <<<cpan-head +see>>>

=back

=head2 Meta Data Used

=over

=item C<name>

Dist or module name

=item C<abstract>

Dist abstract

=item C<version>

Dist version

=item C<author/name>

Author's full name

=item C<author/email>

Author's email address

=item C<badge>

One or more badge types. Optional.

=item C<see>

List of links or module names. Optional.

=back

=head1 SEE ALSO

=over

=item * L<Swim>

=back

=head1 AUTHOR

Ingy döt Net <ingy@cpan.org>

=head1 COPYRIGHT AND LICENSE

Copyright 2014-2015. Ingy döt Net.

This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.

See L<http://www.perl.com/perl/misc/Artistic.html>

=cut
