NAME

    Pod::Weaver::Section::SeeAlso - add a SEE ALSO pod section

VERSION

      This document describes v1.003 of Pod::Weaver::Section::SeeAlso - released October 25, 2014 as part of Pod-Weaver-Section-SeeAlso.

DESCRIPTION

    This section plugin will produce a hunk of pod that references the main
    module of a dist from its submodules, and adds any other text already
    present in the POD. It will do this only if it is being built with
    Dist::Zilla, because it needs the data from the dzil object.

    In the main module, this section plugin just transforms the links into
    a proper list. In the submodules, it also adds the link to the main
    module.

    For an example of what the hunk looks like, look at the "SEE ALSO"
    section in this POD :)

    WARNING: Please do not put any POD commands in your SEE ALSO section!

    What you should do when you want to add extra links is:

            =head1 SEE ALSO
            Foo::Bar
            Bar::Baz
            www.cpan.org

    And this module will automatically convert it into:

            =head1 SEE ALSO
            =over 4
            =item *
            L<Main::Module>
            =item *
            L<Foo::Bar>
            =item *
            L<Bar::Baz>
            =item *
            L<www.cpan.org>
            =back

    You can specify more links by using the "links" attribute, or by
    specifying it as a comment. The format of the comment is:

            # SEEALSO: Foo::Bar, Module::Nice::Foo, www.foo.com

    The way the links are ordered is: POD in the module, links attribute,
    comment links.

ATTRIBUTES

 add_main_link

    A boolean value controlling whether the link back to the main module
    should be added in the submodules.

    Defaults to true.

 header

    Specify the content to be displayed before the list of links is shown.

    The default is a sufficient explanation (see "SEE ALSO").

 links

    Specify a list of links you want to add to the SEE ALSO section.

    You can either specify it like this: "Moose" or do it in POD format:
    "Moose". This module will automatically add the proper POD formatting
    if it is missing.

    The default is an empty list.

SEE ALSO

    Please see those modules/websites for more information related to this
    module.

      * Pod::Weaver

      * Dist::Zilla

SUPPORT

 Perldoc

    You can find documentation for this module with the perldoc command.

      perldoc Pod::Weaver::Section::SeeAlso

 Websites

    The following websites have more information about this module, and may
    be of help to you. As always, in addition to those websites please use
    your favorite search engine to discover more resources.

      * MetaCPAN

      A modern, open-source CPAN search engine, useful to view POD in HTML
      format.

      http://metacpan.org/release/Pod-Weaver-Section-SeeAlso

      * Search CPAN

      The default CPAN search engine, useful to view POD in HTML format.

      http://search.cpan.org/dist/Pod-Weaver-Section-SeeAlso

      * RT: CPAN's Bug Tracker

      The RT ( Request Tracker ) website is the default bug/issue tracking
      system for CPAN.

      http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-Weaver-Section-SeeAlso

      * AnnoCPAN

      The AnnoCPAN is a website that allows community annotations of Perl
      module documentation.

      http://annocpan.org/dist/Pod-Weaver-Section-SeeAlso

      * CPAN Ratings

      The CPAN Ratings is a website that allows community ratings and
      reviews of Perl modules.

      http://cpanratings.perl.org/d/Pod-Weaver-Section-SeeAlso

      * CPAN Forum

      The CPAN Forum is a web forum for discussing Perl modules.

      http://cpanforum.com/dist/Pod-Weaver-Section-SeeAlso

      * CPANTS

      The CPANTS is a website that analyzes the Kwalitee ( code metrics )
      of a distribution.

      http://cpants.perl.org/dist/overview/Pod-Weaver-Section-SeeAlso

      * CPAN Testers

      The CPAN Testers is a network of smokers who run automated tests on
      uploaded CPAN distributions.

      http://www.cpantesters.org/distro/P/Pod-Weaver-Section-SeeAlso

      * CPAN Testers Matrix

      The CPAN Testers Matrix is a website that provides a visual overview
      of the test results for a distribution on various Perls/platforms.

      http://matrix.cpantesters.org/?dist=Pod-Weaver-Section-SeeAlso

      * CPAN Testers Dependencies

      The CPAN Testers Dependencies is a website that shows a chart of the
      test results of all dependencies for a distribution.

      http://deps.cpantesters.org/?module=Pod::Weaver::Section::SeeAlso

 Email

    You can email the author of this module at APOCAL at cpan.org asking
    for help with any problems you have.

 Internet Relay Chat

    You can get live help by using IRC ( Internet Relay Chat ). If you
    don't know what IRC is, please read this excellent guide:
    http://en.wikipedia.org/wiki/Internet_Relay_Chat. Please be courteous
    and patient when talking to us, as we might be busy or sleeping! You
    can join those networks/channels and get help:

      * irc.perl.org

      You can connect to the server at 'irc.perl.org' and join this
      channel: #perl-help then talk to this person for help: Apocalypse.

      * irc.freenode.net

      You can connect to the server at 'irc.freenode.net' and join this
      channel: #perl then talk to this person for help: Apocal.

      * irc.efnet.org

      You can connect to the server at 'irc.efnet.org' and join this
      channel: #perl then talk to this person for help: Ap0cal.

 Bugs / Feature Requests

    Please report any bugs or feature requests by email to
    bug-pod-weaver-section-seealso at rt.cpan.org, or through the web
    interface at
    http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Weaver-Section-SeeAl
    so. You will be automatically notified of any progress on the request
    by the system.

 Source Code

    The code is open to the world, and available for you to hack on. Please
    feel free to browse it and play with it, or whatever. If you want to
    contribute patches, please send me a diff or prod me to pull from your
    repository :)

    https://github.com/apocalypse/perl-pod-weaver-section-seealso

      git clone git://github.com/apocalypse/perl-pod-weaver-section-seealso.git

AUTHOR

    Apocalypse <APOCAL@cpan.org>

 CONTRIBUTORS

      * Adam Lesperance <lespea@gmail.com>

      * Shlomi Fish <shlomif@shlomifish.org>

COPYRIGHT AND LICENSE

    This software is copyright (c) 2014 by Apocalypse.

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

    The full text of the license can be found in the LICENSE file included
    with this distribution.

DISCLAIMER OF WARRANTY

    THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
    APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
    HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
    WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
    PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
    OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
    ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
    CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
    INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
    ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
    NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
    SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO
    OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
    HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.