Apocalypse > Pod-Weaver-Section-Support > Pod::Weaver::Section::Support

Download:
Pod-Weaver-Section-Support-1.007.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.007   Source  

NAME ^

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

VERSION ^

  This document describes v1.007 of Pod::Weaver::Section::Support - released November 04, 2014 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", "metacpan", "search", "rt", "anno", "ratings", "forum", "kwalitee", "testers", "testmatrix", "deps" and "all".

The default is "all".

        # Where the links go to:
        metacpan        - http://metacpan.org/release/$dist
        search          - http://search.cpan.org/dist/$dist
        rt              - https://rt.cpan.org/Public/Dist/Display.html?Name=$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/$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. There are two ways to format the string:

        servername.com,#room,nick
        irc://servername.com/#room

The default is none.

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

You can also add the irc information in the distribution metadata via Dist::Zilla::Plugin::Metadata. The key is 'x_IRC' but you have to use the irc:// format to retain compatibility with the rest of the ecosystem.

        # in dist.ini
        [Metadata]
        x_IRC = irc://irc.perl.org/#perl

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.

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:

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-Support. 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-support

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

AUTHOR ^

Apocalypse <APOCAL@cpan.org>

CONTRIBUTORS

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.

syntax highlighting: