.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Pod::Weaver::Section::Support 3pm" .TH Pod::Weaver::Section::Support 3pm "2016-11-13" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Pod::Weaver::Section::Support \- Add a SUPPORT section to your POD .SH "VERSION" .IX Header "VERSION" .Vb 1 \& This document describes v1.007 of Pod::Weaver::Section::Support \- released November 04, 2014 as part of Pod\-Weaver\-Section\-Support. .Ve .SH "DESCRIPTION" .IX Header "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. .PP If you have Dist::Zilla::Plugin::Repository enabled in your \fIdist.ini\fR, be sure to check the repository_link attribute! .PP This is added \fB\s-1ONLY\s0\fR to the main module's \s-1POD,\s0 because it would be a waste of space to add it to all modules in the dist. .PP For an example of what the hunk looks like, look at the \*(L"\s-1SUPPORT\*(R"\s0 section in this \s-1POD :\s0) .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "all_modules" .IX Subsection "all_modules" Enable this if you want to add the \s-1SUPPORT\s0 section to all the modules in a dist, not only the main one. .PP The default is false. .SS "perldoc" .IX Subsection "perldoc" Specify if you want the paragraph explaining about perldoc to be displayed or not. .PP The default is true. .SS "bugs" .IX Subsection "bugs" Specify the bugtracker you want to use. You can use the \s-1CPAN RT\s0 tracker or your own, specified in the metadata. .PP Valid options are: \*(L"rt\*(R", \*(L"metadata\*(R", or \*(L"none\*(R" .PP If you pick the \*(L"rt\*(R" option, this module will generate a predefined block of text explaining how to use the \s-1RT\s0 system. .PP If you pick the \*(L"metadata\*(R" 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! .PP The default is \*(L"rt\*(R". .SS "bugs_content" .IX Subsection "bugs_content" Specify the content for the bugs section. .PP Please put the \*(L"{\s-1EMAIL\s0}\*(R" and \*(L"{\s-1WEB\s0}\*(R" placeholders somewhere! .PP The default is a sufficient explanation (see \*(L"\s-1SUPPORT\*(R"\s0). .SS "websites" .IX Subsection "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 \s-1POD.\s0 .PP Valid options are: \*(L"none\*(R", \*(L"metacpan\*(R", \*(L"search\*(R", \*(L"rt\*(R", \*(L"anno\*(R", \*(L"ratings\*(R", \*(L"forum\*(R", \*(L"kwalitee\*(R", \*(L"testers\*(R", \*(L"testmatrix\*(R", \*(L"deps\*(R" and \*(L"all\*(R". .PP The default is \*(L"all\*(R". .PP .Vb 11 \& # 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 .Ve .PP P.S. If you know other websites that I should include here, please let me know! .SS "websites_content" .IX Subsection "websites_content" Specify the content to be displayed before the website list. .PP The default is a sufficient explanation (see \*(L"\s-1SUPPORT\*(R"\s0). .SS "irc" .IX Subsection "irc" Specify an \s-1IRC\s0 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 \s-1POD.\s0 .PP You specify a network, then a list of channels/nicks to ask for support. There are two ways to format the string: .PP .Vb 2 \& servername.com,#room,nick \& irc://servername.com/#room .Ve .PP The default is none. .PP .Vb 4 \& # in weaver.ini \& [Support] \& irc = irc.home.org, #support, supportbot \& irc = irc.acme.com, #acmecorp, #acmehelp, #acmenewbies .Ve .PP 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. .PP .Vb 3 \& # in dist.ini \& [Metadata] \& x_IRC = irc://irc.perl.org/#perl .Ve .SS "irc_content" .IX Subsection "irc_content" Specify the content to be displayed before the irc network/channel list. .PP The default is a sufficient explanation (see \*(L"\s-1SUPPORT\*(R"\s0). .SS "repository_link" .IX Subsection "repository_link" Specify which url to use when composing the external link. The value corresponds to the repository meta resources (for dzil v3 with \s-1CPAN\s0 Meta v2). .PP Valid options are: \*(L"url\*(R", \*(L"web\*(R", \*(L"both\*(R", or \*(L"none\*(R". .PP \&\*(L"both\*(R" will include links to both the \*(L"url\*(R" and \*(L"web\*(R" in separate \s-1POD\s0 paragraphs. .PP \&\*(L"none\*(R" will skip the repository item entirely. .PP The default is \*(L"both\*(R". .PP 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. .SS "repository_content" .IX Subsection "repository_content" Specify the content to be displayed before the link to the source code repository. .PP The default is a sufficient explanation (see \*(L"\s-1SUPPORT\*(R"\s0). .SS "email" .IX Subsection "email" Specify an email address here so users can contact you directly for help. .PP If you supply a string without '@' in it, we assume it is a \s-1PAUSE\s0 id and mangle it into '\s-1USER\s0 at cpan.org'. .PP The default is none. .SS "email_content" .IX Subsection "email_content" Specify the content for the email section. .PP Please put the \*(L"{\s-1EMAIL\s0}\*(R" placeholder somewhere! .PP The default is a sufficient explanation ( see \*(L"\s-1SUPPORT\*(R"\s0). .SH "SUPPORT" .IX Header "SUPPORT" .SS "Perldoc" .IX Subsection "Perldoc" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc Pod::Weaver::Section::Support .Ve .SS "Websites" .IX Subsection "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. .IP "\(bu" 4 MetaCPAN .Sp A modern, open-source \s-1CPAN\s0 search engine, useful to view \s-1POD\s0 in \s-1HTML\s0 format. .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp The default \s-1CPAN\s0 search engine, useful to view \s-1POD\s0 in \s-1HTML\s0 format. .Sp .IP "\(bu" 4 \&\s-1RT: CPAN\s0's Bug Tracker .Sp The \s-1RT \s0( Request Tracker ) website is the default bug/issue tracking system for \s-1CPAN.\s0 .Sp .IP "\(bu" 4 AnnoCPAN .Sp The AnnoCPAN is a website that allows community annotations of Perl module documentation. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp The \s-1CPAN\s0 Ratings is a website that allows community ratings and reviews of Perl modules. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Forum .Sp The \s-1CPAN\s0 Forum is a web forum for discussing Perl modules. .Sp .IP "\(bu" 4 \&\s-1CPANTS\s0 .Sp The \s-1CPANTS\s0 is a website that analyzes the Kwalitee ( code metrics ) of a distribution. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers .Sp The \s-1CPAN\s0 Testers is a network of smokers who run automated tests on uploaded \s-1CPAN\s0 distributions. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers Matrix .Sp The \s-1CPAN\s0 Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers Dependencies .Sp The \s-1CPAN\s0 Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. .Sp .SS "Email" .IX Subsection "Email" You can email the author of this module at \f(CW\*(C`APOCAL at cpan.org\*(C'\fR asking for help with any problems you have. .SS "Internet Relay Chat" .IX Subsection "Internet Relay Chat" You can get live help by using \s-1IRC \s0( Internet Relay Chat ). If you don't know what \s-1IRC\s0 is, please read this excellent guide: . 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: .IP "\(bu" 4 irc.perl.org .Sp You can connect to the server at 'irc.perl.org' and join this channel: #perl\-help then talk to this person for help: Apocalypse. .IP "\(bu" 4 irc.freenode.net .Sp You can connect to the server at 'irc.freenode.net' and join this channel: #perl then talk to this person for help: Apocal. .IP "\(bu" 4 irc.efnet.org .Sp You can connect to the server at 'irc.efnet.org' and join this channel: #perl then talk to this person for help: Ap0cal. .SS "Bugs / Feature Requests" .IX Subsection "Bugs / Feature Requests" Please report any bugs or feature requests by email to \f(CW\*(C`bug\-pod\-weaver\-section\-support at rt.cpan.org\*(C'\fR, or through the web interface at . You will be automatically notified of any progress on the request by the system. .SS "Source Code" .IX Subsection "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 :) .PP .PP .Vb 1 \& git clone https://github.com/apocalypse/perl\-pod\-weaver\-section\-support.git .Ve .SH "AUTHOR" .IX Header "AUTHOR" Apocalypse .SS "\s-1CONTRIBUTORS\s0" .IX Subsection "CONTRIBUTORS" .IP "\(bu" 4 Alex Peters .IP "\(bu" 4 Kent Fredric .IP "\(bu" 4 Randy Stauner .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2014 by Apocalypse. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .PP The full text of the license can be found in the \&\fI\s-1LICENSE\s0\fR file included with this distribution. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" \&\s-1THERE 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 \*(L"AS IS\*(R" 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.\s0 .PP \&\s-1IN 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 \s0(\s-1INCLUDING 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\s0), \&\s-1EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\s0