NAME
    Pod::Weaver::Section::Support - Add a SUPPORT section to your POD

VERSION
      This document describes v1.004 of Pod::Weaver::Section::Support - released April 21, 2011 as part of Pod-Weaver-Section-Support.

DESCRIPTION
    This section plugin will produce a hunk of pod that lists the various
    ways to get support for this module. It will do this only if it is being
    built with Dist::Zilla because it needs the data from the dzil object.

    If you have Dist::Zilla::Plugin::Repository enabled in your dist.ini, be
    sure to check the repository_link attribute!

    This is added ONLY to the main module's POD, because it would be a waste
    of space to add it to all modules in the dist.

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

ATTRIBUTES
  all_modules
    Enable this if you want to add the SUPPORT section to all the modules in
    a dist, not only the main one.

    The default is false.

  perldoc
    Specify if you want the paragraph explaining about perldoc to be
    displayed or not.

    The default is true.

  bugs
    Specify the bugtracker you want to use. You can use the CPAN RT tracker
    or your own, specified in the metadata.

    Valid options are: "rt", "metadata", or "none"

    If you pick the "rt" option, this module will generate a predefined
    block of text explaining how to use the RT system.

    If you pick the "metadata" option, this module will check the
    Dist::Zilla metadata for the bugtracker to display. Be sure to verify
    that your metadata contains both 'web' and 'mailto' keys if you want to
    use them in the content!

    The default is "rt".

  bugs_content
    Specify the content for the bugs section.

    Please put the "{EMAIL}" and "{WEB}" placeholders somewhere!

    The default is a sufficient explanation (see "SUPPORT").

  websites
    Specify what website links you want to see. This is an array, and you
    can pick any combination. You can also specify it as a comma-delimited
    string. The ordering of the options are important, as they are reflected
    in the final POD.

    Valid options are: "none", "search", "rt", "anno", "ratings", "forum",
    "kwalitee", "testers", "testmatrix", "deps" and "all".

    The default is "all".

            # Where the links go to:
            search          - http://search.cpan.org/dist/$dist
            rt              - http://rt.cpan.org/NoAuth/Bugs.html?Dist=$dist
            anno            - http://annocpan.org/dist/$dist
            ratings         - http://cpanratings.perl.org/d/$dist
            forum           - http://cpanforum.com/dist/$dist
            kwalitee        - http://cpants.perl.org/dist/overview/$dist
            testers         - http://cpantesters.org/distro/$first_char/$dist
            testmatrix      - http://matrix.cpantesters.org/?dist=$dist
            deps            - http://deps.cpantesters.org/?module=$module

            # in weaver.ini
            [Support]
            websites = search
            websites = forum
            websites = testers , testmatrix

    P.S. If you know other websites that I should include here, please let
    me know!

  websites_content
    Specify the content to be displayed before the website list.

    The default is a sufficient explanation (see "SUPPORT").

  irc
    Specify an IRC server/channel/nick for online support. You can specify
    as many networks/channels as you want. The ordering of the options are
    important, as they are reflected in the final POD.

    You specify a network, then a list of channels/nicks to ask for support.

    The default is none.

            # in weaver.ini
            [Support]
            irc = irc.home.org, #support, supportbot
            irc = irc.acme.com, #acmecorp, #acmehelp, #acmenewbies

  irc_content
    Specify the content to be displayed before the irc network/channel list.

    The default is a sufficient explanation (see "SUPPORT").

  repository_link
    Specify which url to use when composing the external link. The value
    corresponds to the repository meta resources (for dzil v3 with CPAN Meta
    v2).

    Valid options are: "url", "web", "both", or "none".

    "both" will include links to both the "url" and "web" in separate POD
    paragraphs.

    "none" will skip the repository item entirely.

    The default is "both".

    An error will be thrown if a specified link is not found because if you
    said that you wanted it you probably expect it to be there.

  repository_content
    Specify the content to be displayed before the link to the source code
    repository.

    The default is a sufficient explanation (see "SUPPORT").

  email
    Specify an email address here so users can contact you directly for
    help.

    If you supply a string without '@' in it, we assume it is a PAUSE id and
    mangle it into 'USER at cpan.org'.

    The default is none.

  email_content
    Specify the content for the email section.

    Please put the "{EMAIL}" placeholder somewhere!

    The default is a sufficient explanation ( see "SUPPORT").

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

      perldoc Pod::Weaver::Section::Support

  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.

    *   Search CPAN

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

        <http://search.cpan.org/dist/Pod-Weaver-Section-Support>

    *   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-Support
        >

    *   AnnoCPAN

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

        <http://annocpan.org/dist/Pod-Weaver-Section-Support>

    *   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-Support>

    *   CPAN Forum

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

        <http://cpanforum.com/dist/Pod-Weaver-Section-Support>

    *   CPANTS

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

        <http://cpants.perl.org/dist/overview/Pod-Weaver-Section-Support>

    *   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-Support>

    *   CPAN Testers Matrix

        The CPAN Testers Matrix is a website that provides a visual way to
        determine what Perls/platforms PASSed for a distribution.

        <http://matrix.cpantesters.org/?dist=Pod-Weaver-Section-Support>

    *   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::Support>

  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-support at rt.cpan.org", or through the web
    interface at
    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Weaver-Section-Suppo
    rt>. 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 :)

    <http://github.com/apocalypse/perl-pod-weaver-section-support>

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

AUTHOR
    Apocalypse <APOCAL@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2011 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
    BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
    FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
    PROVIDE THE SOFTWARE "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 SOFTWARE IS WITH
    YOU. SHOULD THE SOFTWARE 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 MAY MODIFY AND/OR
    REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
    TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
    SOFTWARE (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 SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
    SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
    DAMAGES.

