Pod-Weaver-Section-Support-1.014000755000764000764 014460147160 17044 5ustar00shlomifshlomif000000000000README100644000764000764 57414460147160 17773 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014This archive contains the distribution Pod-Weaver-Section-Support, version 1.014: Add a SUPPORT section to your POD This software is copyright (c) 2010 by Apocalyptic. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. This README file was generated by Dist::Zilla::Plugin::Readme v6.030. Changes100644000764000764 1014114460147160 20435 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014Revision history for Pod::Weaver::Section::Support 1.014 2023-07-26 - Remove broken links to old resources from all: - https://github.com/shlomif/perl-pod-weaver-section-support/pull/4 - Thanks to @haarg . 1.013 2020-02-07 - Remove broken links to old resources: - https://github.com/shlomif/HTML-Spelling-Site/issues/2 - Thanks to @tobyink . 1.012 2019-12-28 - Exclude files using MANIFEST.SKIP. - https://github.com/shlomif/perl-pod-weaver-section-support/issues/3 - Thanks to @did38fr . 1.011 2019-12-20 - Remove AnnoCPAN: - See https://github.com/shlomif/perl-pod-weaver-section-support/issues/2 - Thanks to @mjgardner ! 1.010 2018-03-31 - Remove the perldoc section if it contains trailing whitespace. 1.009 2017-11-21 - Manually apply a patch from Debian to add a =head1 NAME section to the POD. - See https://github.com/shlomif/perl-pod-weaver-section-support/issues/1 - Thanks! 1.008 2017-10-18 - Maintenance resumed by SHLOMIF . - Use https:// for MetaCPAN ( thanks DOLMEN! ) - Remove need for autobox ( thanks KENTNL! ) - perldoc $module rather than perldoc $main_module (RT#101917) - Thanks to Peter Roberts - Remove link to CPAN forum as it was discontinued. - https://rt.cpan.org/Ticket/Display.html?id=101918 - Thanks to PWR for the report. - Fix https://rt.cpan.org/Ticket/Display.html?id=119990 - Rephrase as 'smoke testers'. - Thanks to BKB . 1.007 2014-11-04T22:34:49Z UTC - Fix the Kwalitee link so it doesn't 404 anymore - Tweaked how we parsed the x_IRC metadata [STATISTICS] - code churn: 3 files changed, 392 insertions(+), 17 deletions(-) 1.006 2014-10-26T05:12:19Z UTC - Documentation tweaks - Resolve RT#78450 - retrieve IRC information from the dzil metadata if possible ( thanks BBYRD! ) 1.005 2012-01-03T00:48:32Z UTC - Add the MetaCPAN website to the website list ( thanks RWSTAUNER! ) - Tweak the logging system a bit ( thanks KENTNL! ) - Fix some internal spelling mistakes ( thanks RWSTAUNER! ) - Resolve RT#69033 - logging tweaks ( thanks RJBS! ) 1.004 2011-04-21T21:48:17Z UTC - Tweaked the output of the websites so it also includes a descriptive text of the link - Add the deps.cpantesters.org website ( deps ) to the website list 1.003 2011-02-24T17:03:11Z UTC - Made sure the bugs_content and the metadata match up, otherwise it will throw an error! ( thanks XENO! ) - Changed the *_content attributes to arrayrefs so you can sanely use them in a weaver.ini ( thanks XENO! ) - The email attribute didn't add C<> to the address if you specified your own ( thanks XENO! ) 1.002 2011-02-02T22:55:07Z UTC - Fix a few typos in the POD - Add email section to contact the author - Make the perldoc section a proper header - Tweaked the wording of the bugs section ( thanks DAGOLDEN! ) - Add attribute to specify the bugs content ( thanks DAGOLDEN! ) - Add attribute to specify the website content 1.001 2010-12-08T07:35:41Z UTC - Add attributes to control the repository section ( thanks RWSTAUNER! ) - Reorganized the layout of the generated POD - Add attribute to control the website links ( thanks GETTY! ) - Add attributes for new irc section ( thanks GETTY! ) - Add attribute to control the bugs section ( thanks GETTY! ) - Add attribute to enable/disable perldoc section ( thanks GETTY! ) - Add attribute to enable/disable SUPPORT section for all modules ( thanks GETTY! ) 1.000 2010-05-30T18:03:49Z UTC - Work with CPAN Meta v2 by recognizing the repository - Make the repository hunk of POD optional 0.010 2010-05-28T17:41:54Z UTC - fixed the way the stopwords were added to the POD 0.009 2010-05-13T01:41:59Z UTC - another fake release 0.008 2010-05-12T04:50:01Z UTC - fake release 0.007 2010-05-11T21:12:28Z UTC - fake release 0.006 2010-05-11T17:05:55Z UTC - Tweaked the POD a little, and make another release... 0.005 2010-05-11T06:26:29Z UTC - real CPAN release, ha! 0.004 2010-05-11T06:25:00Z UTC - add example weaver.ini 0.003 2010-05-11T06:16:15Z UTC - yet another test release 0.002 2010-05-11T06:13:52Z UTC - test release 0.001 2010-05-11T03:29:40Z UTC - initial release LICENSE100644000764000764 5013114460147160 20152 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014Terms of Perl itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" ---------------------------------------------------------------------------- GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. 12. 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 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. END OF TERMS AND CONDITIONS ---------------------------------------------------------------------------- The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End dist.ini100644000764000764 77714460147160 20564 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014name = Pod-Weaver-Section-Support author = Shlomi Fish license = Perl_5 copyright_holder = Apocalyptic copyright_year = 2010 version = 1.014 [@Filter] -bundle = @SHLOMIF -remove = Authority -remove = License -remove = Test::Kwalitee::Extra -remove = Test::NoTabs dist = Pod-Weaver-Section-Support repository = github repository_url = https://github.com/shlomif/perl-pod-weaver-section-support repository_web = https://github.com/shlomif/perl-pod-weaver-section-support repository_type = git META.yml100644000764000764 2325714460147160 20427 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014--- abstract: 'Add a SUPPORT section to your POD' author: - 'Shlomi Fish ' build_requires: File::Spec: '0' IO::Handle: '0' IPC::Open3: '0' Module::Build: '0.28' Test::More: '0.88' perl: '5.006' warnings: '0' configure_requires: ExtUtils::MakeMaker: '0' Module::Build: '0.28' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.030, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Pod-Weaver-Section-Support provides: Pod::Weaver::Section::Support: file: lib/Pod/Weaver/Section/Support.pm version: '1.014' requires: Moose: '1.03' Moose::Util::TypeConstraints: '1.01' PPIx::DocumentName: '0' Pod::Weaver::Role::Section: '3.100710' strict: '0' resources: bugtracker: https://github.com/shlomif/pod-weaver-section-support/issues homepage: http://metacpan.org/release/Pod-Weaver-Section-Support repository: https://github.com/shlomif/perl-pod-weaver-section-support version: '1.014' x_Dist_Zilla: perl: version: '5.036001' plugins: - class: Dist::Zilla::Plugin::Prereqs config: Dist::Zilla::Plugin::Prereqs: phase: test type: requires name: '@Filter/TestMoreDoneTesting' version: '6.030' - class: Dist::Zilla::Plugin::AutoPrereqs name: '@Filter/AutoPrereqs' version: '6.030' - class: Dist::Zilla::Plugin::ExecDir name: '@Filter/ExecDir' version: '6.030' - class: Dist::Zilla::Plugin::GatherDir config: Dist::Zilla::Plugin::GatherDir: exclude_filename: [] exclude_match: [] follow_symlinks: 0 include_dotfiles: 0 prefix: '' prune_directory: [] root: . name: '@Filter/GatherDir' version: '6.030' - class: Dist::Zilla::Plugin::ManifestSkip name: '@Filter/ManifestSkip' version: '6.030' - class: Dist::Zilla::Plugin::MetaYAML name: '@Filter/MetaYAML' version: '6.030' - class: Dist::Zilla::Plugin::PruneCruft name: '@Filter/PruneCruft' version: '6.030' - class: Dist::Zilla::Plugin::Readme name: '@Filter/Readme' version: '6.030' - class: Dist::Zilla::Plugin::RunExtraTests config: Dist::Zilla::Role::TestRunner: default_jobs: 1 name: '@Filter/RunExtraTests' version: '0.029' - class: Dist::Zilla::Plugin::ShareDir name: '@Filter/ShareDir' version: '6.030' - class: Dist::Zilla::Plugin::MakeMaker config: Dist::Zilla::Role::TestRunner: default_jobs: 1 name: '@Filter/MakeMaker' version: '6.030' - class: Dist::Zilla::Plugin::CheckChangesHasContent name: '@Filter/CheckChangesHasContent' version: '0.011' - class: Dist::Zilla::Plugin::ConfirmRelease name: '@Filter/ConfirmRelease' version: '6.030' - class: Dist::Zilla::Plugin::Manifest name: '@Filter/Manifest' version: '6.030' - class: Dist::Zilla::Plugin::MetaConfig name: '@Filter/MetaConfig' version: '6.030' - class: Dist::Zilla::Plugin::MetaJSON name: '@Filter/MetaJSON' version: '6.030' - class: Dist::Zilla::Plugin::MetaProvides::Package config: Dist::Zilla::Plugin::MetaProvides::Package: finder_objects: - class: Dist::Zilla::Plugin::FinderCode name: '@Filter/MetaProvides::Package/AUTOVIV/:InstallModulesPM' version: '6.030' include_underscores: 0 Dist::Zilla::Role::MetaProvider::Provider: $Dist::Zilla::Role::MetaProvider::Provider::VERSION: '2.002004' inherit_missing: 1 inherit_version: 1 meta_noindex: 1 Dist::Zilla::Role::ModuleMetadata: Module::Metadata: '1.000037' version: '0.006' name: '@Filter/MetaProvides::Package' version: '2.004003' - class: Dist::Zilla::Plugin::MetaResources name: '@Filter/MetaResources' version: '6.030' - class: Dist::Zilla::Plugin::ModuleBuild config: Dist::Zilla::Role::TestRunner: default_jobs: 1 name: '@Filter/ModuleBuild' version: '6.030' - class: Dist::Zilla::Plugin::PkgVersion name: '@Filter/PkgVersion' version: '6.030' - class: Dist::Zilla::Plugin::PodCoverageTests name: '@Filter/PodCoverageTests' version: '6.030' - class: Dist::Zilla::Plugin::PodSyntaxTests name: '@Filter/PodSyntaxTests' version: '6.030' - class: Dist::Zilla::Plugin::Test::Compile config: Dist::Zilla::Plugin::Test::Compile: bail_out_on_fail: 0 fail_on_warning: author fake_home: 0 filename: t/00-compile.t module_finder: - ':InstallModules' needs_display: 0 phase: test script_finder: - ':PerlExecFiles' skips: [] switch: [] name: '@Filter/Test::Compile' version: '2.058' - class: Dist::Zilla::Plugin::Test::CPAN::Changes config: Dist::Zilla::Plugin::Test::CPAN::Changes: changelog: Changes name: '@Filter/Test::CPAN::Changes' version: '0.012' - class: Dist::Zilla::Plugin::Test::EOL config: Dist::Zilla::Plugin::Test::EOL: filename: xt/author/eol.t finder: - ':ExecFiles' - ':InstallModules' - ':TestFiles' trailing_whitespace: 1 name: '@Filter/Test::EOL' version: '0.19' - class: Dist::Zilla::Plugin::Test::TrailingSpace name: '@Filter/Test::TrailingSpace' version: ~ - class: Dist::Zilla::Plugin::TestRelease name: '@Filter/TestRelease' version: '6.030' - class: Dist::Zilla::Plugin::PodWeaver config: Dist::Zilla::Plugin::PodWeaver: finder: - ':InstallModules' - ':PerlExecFiles' plugins: - class: Pod::Weaver::Plugin::EnsurePod5 name: '@CorePrep/EnsurePod5' version: '4.019' - class: Pod::Weaver::Plugin::H1Nester name: '@CorePrep/H1Nester' version: '4.019' - class: Pod::Weaver::Plugin::SingleEncoding name: -SingleEncoding version: '4.019' - class: Pod::Weaver::Section::Generic name: NAME version: '4.019' - class: Pod::Weaver::Section::Version name: Version version: '4.019' - class: Pod::Weaver::Section::Region name: prelude version: '4.019' - class: Pod::Weaver::Section::Generic name: SYNOPSIS version: '4.019' - class: Pod::Weaver::Section::Generic name: DESCRIPTION version: '4.019' - class: Pod::Weaver::Section::Generic name: OVERVIEW version: '4.019' - class: Pod::Weaver::Section::Collect name: ATTRIBUTES version: '4.019' - class: Pod::Weaver::Section::Collect name: METHODS version: '4.019' - class: Pod::Weaver::Section::Leftovers name: Leftovers version: '4.019' - class: Pod::Weaver::Section::Region name: postlude version: '4.019' - class: Pod::Weaver::Section::Authors name: Authors version: '4.019' - class: Pod::Weaver::Section::Legal name: Legal version: '4.019' - class: Pod::Weaver::Section::Bugs name: Bugs version: '4.019' - class: Pod::Weaver::Section::Support name: Support version: '1.014' name: '@Filter/PodWeaver' version: '4.010' - class: Dist::Zilla::Plugin::UploadToCPAN name: '@Filter/UploadToCPAN' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':InstallModules' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':IncModules' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':TestFiles' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':ExtraTestFiles' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':ExecFiles' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':PerlExecFiles' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':ShareFiles' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':MainModule' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':AllFiles' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: ':NoFiles' version: '6.030' - class: Dist::Zilla::Plugin::FinderCode name: '@Filter/MetaProvides::Package/AUTOVIV/:InstallModulesPM' version: '6.030' zilla: class: Dist::Zilla::Dist::Builder config: is_trial: 0 version: '6.030' x_generated_by_perl: v5.36.1 x_serialization_backend: 'YAML::Tiny version 1.74' x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' MANIFEST100644000764000764 61614460147160 20241 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.030. Build.PL Changes LICENSE MANIFEST MANIFEST.SKIP META.json META.yml Makefile.PL README README.pod appveyor.yml dist.ini examples/weaver.ini lib/Pod/Weaver/Section/Support.pm t/00-compile.t weaver.ini xt/author/eol.t xt/author/pod-coverage.t xt/author/pod-syntax.t xt/release/cpan-changes.t xt/release/trailing-space.t Build.PL100644000764000764 262214460147160 20423 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014 # This file was automatically generated by Dist::Zilla::Plugin::ModuleBuild v6.030. use strict; use warnings; use Module::Build 0.28; my %module_build_args = ( "build_requires" => { "Module::Build" => "0.28" }, "configure_requires" => { "ExtUtils::MakeMaker" => 0, "Module::Build" => "0.28" }, "dist_abstract" => "Add a SUPPORT section to your POD", "dist_author" => [ "Shlomi Fish " ], "dist_name" => "Pod-Weaver-Section-Support", "dist_version" => "1.014", "license" => "perl", "module_name" => "Pod::Weaver::Section::Support", "recursive_test_files" => 1, "requires" => { "Moose" => "1.03", "Moose::Util::TypeConstraints" => "1.01", "PPIx::DocumentName" => 0, "Pod::Weaver::Role::Section" => "3.100710", "strict" => 0 }, "test_requires" => { "File::Spec" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Test::More" => "0.88", "perl" => "5.006", "warnings" => 0 } ); my %fallback_build_requires = ( "File::Spec" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Module::Build" => "0.28", "Test::More" => "0.88", "perl" => "5.006", "warnings" => 0 ); unless ( eval { Module::Build->VERSION(0.4004) } ) { delete $module_build_args{test_requires}; $module_build_args{build_requires} = \%fallback_build_requires; } my $build = Module::Build->new(%module_build_args); $build->create_build_script; META.json100644000764000764 3664114460147160 20600 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014{ "abstract" : "Add a SUPPORT section to your POD", "author" : [ "Shlomi Fish " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.030, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Pod-Weaver-Section-Support", "prereqs" : { "build" : { "requires" : { "Module::Build" : "0.28" } }, "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0", "Module::Build" : "0.28" } }, "develop" : { "requires" : { "Pod::Coverage::TrustPod" : "0", "Test::CPAN::Changes" : "0.19", "Test::EOL" : "0", "Test::More" : "0.96", "Test::Pod" : "1.41", "Test::Pod::Coverage" : "1.08", "Test::TrailingSpace" : "0.0203", "warnings" : "0" } }, "runtime" : { "requires" : { "Moose" : "1.03", "Moose::Util::TypeConstraints" : "1.01", "PPIx::DocumentName" : "0", "Pod::Weaver::Role::Section" : "3.100710", "strict" : "0" } }, "test" : { "requires" : { "File::Spec" : "0", "IO::Handle" : "0", "IPC::Open3" : "0", "Test::More" : "0.88", "perl" : "5.006", "warnings" : "0" } } }, "provides" : { "Pod::Weaver::Section::Support" : { "file" : "lib/Pod/Weaver/Section/Support.pm", "version" : "1.014" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/shlomif/pod-weaver-section-support/issues" }, "homepage" : "http://metacpan.org/release/Pod-Weaver-Section-Support", "repository" : { "type" : "git", "url" : "https://github.com/shlomif/perl-pod-weaver-section-support", "web" : "https://github.com/shlomif/perl-pod-weaver-section-support" } }, "version" : "1.014", "x_Dist_Zilla" : { "perl" : { "version" : "5.036001" }, "plugins" : [ { "class" : "Dist::Zilla::Plugin::Prereqs", "config" : { "Dist::Zilla::Plugin::Prereqs" : { "phase" : "test", "type" : "requires" } }, "name" : "@Filter/TestMoreDoneTesting", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::AutoPrereqs", "name" : "@Filter/AutoPrereqs", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::ExecDir", "name" : "@Filter/ExecDir", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::GatherDir", "config" : { "Dist::Zilla::Plugin::GatherDir" : { "exclude_filename" : [], "exclude_match" : [], "follow_symlinks" : 0, "include_dotfiles" : 0, "prefix" : "", "prune_directory" : [], "root" : "." } }, "name" : "@Filter/GatherDir", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::ManifestSkip", "name" : "@Filter/ManifestSkip", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::MetaYAML", "name" : "@Filter/MetaYAML", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::PruneCruft", "name" : "@Filter/PruneCruft", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::Readme", "name" : "@Filter/Readme", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::RunExtraTests", "config" : { "Dist::Zilla::Role::TestRunner" : { "default_jobs" : 1 } }, "name" : "@Filter/RunExtraTests", "version" : "0.029" }, { "class" : "Dist::Zilla::Plugin::ShareDir", "name" : "@Filter/ShareDir", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::MakeMaker", "config" : { "Dist::Zilla::Role::TestRunner" : { "default_jobs" : 1 } }, "name" : "@Filter/MakeMaker", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::CheckChangesHasContent", "name" : "@Filter/CheckChangesHasContent", "version" : "0.011" }, { "class" : "Dist::Zilla::Plugin::ConfirmRelease", "name" : "@Filter/ConfirmRelease", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::Manifest", "name" : "@Filter/Manifest", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::MetaConfig", "name" : "@Filter/MetaConfig", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::MetaJSON", "name" : "@Filter/MetaJSON", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::MetaProvides::Package", "config" : { "Dist::Zilla::Plugin::MetaProvides::Package" : { "finder_objects" : [ { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : "@Filter/MetaProvides::Package/AUTOVIV/:InstallModulesPM", "version" : "6.030" } ], "include_underscores" : 0 }, "Dist::Zilla::Role::MetaProvider::Provider" : { "$Dist::Zilla::Role::MetaProvider::Provider::VERSION" : "2.002004", "inherit_missing" : 1, "inherit_version" : 1, "meta_noindex" : 1 }, "Dist::Zilla::Role::ModuleMetadata" : { "Module::Metadata" : "1.000037", "version" : "0.006" } }, "name" : "@Filter/MetaProvides::Package", "version" : "2.004003" }, { "class" : "Dist::Zilla::Plugin::MetaResources", "name" : "@Filter/MetaResources", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::ModuleBuild", "config" : { "Dist::Zilla::Role::TestRunner" : { "default_jobs" : 1 } }, "name" : "@Filter/ModuleBuild", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::PkgVersion", "name" : "@Filter/PkgVersion", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::PodCoverageTests", "name" : "@Filter/PodCoverageTests", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::PodSyntaxTests", "name" : "@Filter/PodSyntaxTests", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::Test::Compile", "config" : { "Dist::Zilla::Plugin::Test::Compile" : { "bail_out_on_fail" : 0, "fail_on_warning" : "author", "fake_home" : 0, "filename" : "t/00-compile.t", "module_finder" : [ ":InstallModules" ], "needs_display" : 0, "phase" : "test", "script_finder" : [ ":PerlExecFiles" ], "skips" : [], "switch" : [] } }, "name" : "@Filter/Test::Compile", "version" : "2.058" }, { "class" : "Dist::Zilla::Plugin::Test::CPAN::Changes", "config" : { "Dist::Zilla::Plugin::Test::CPAN::Changes" : { "changelog" : "Changes" } }, "name" : "@Filter/Test::CPAN::Changes", "version" : "0.012" }, { "class" : "Dist::Zilla::Plugin::Test::EOL", "config" : { "Dist::Zilla::Plugin::Test::EOL" : { "filename" : "xt/author/eol.t", "finder" : [ ":ExecFiles", ":InstallModules", ":TestFiles" ], "trailing_whitespace" : 1 } }, "name" : "@Filter/Test::EOL", "version" : "0.19" }, { "class" : "Dist::Zilla::Plugin::Test::TrailingSpace", "name" : "@Filter/Test::TrailingSpace", "version" : null }, { "class" : "Dist::Zilla::Plugin::TestRelease", "name" : "@Filter/TestRelease", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::PodWeaver", "config" : { "Dist::Zilla::Plugin::PodWeaver" : { "finder" : [ ":InstallModules", ":PerlExecFiles" ], "plugins" : [ { "class" : "Pod::Weaver::Plugin::EnsurePod5", "name" : "@CorePrep/EnsurePod5", "version" : "4.019" }, { "class" : "Pod::Weaver::Plugin::H1Nester", "name" : "@CorePrep/H1Nester", "version" : "4.019" }, { "class" : "Pod::Weaver::Plugin::SingleEncoding", "name" : "-SingleEncoding", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "NAME", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Version", "name" : "Version", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Region", "name" : "prelude", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "SYNOPSIS", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "DESCRIPTION", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "OVERVIEW", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "ATTRIBUTES", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "METHODS", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Leftovers", "name" : "Leftovers", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Region", "name" : "postlude", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Authors", "name" : "Authors", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Legal", "name" : "Legal", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Bugs", "name" : "Bugs", "version" : "4.019" }, { "class" : "Pod::Weaver::Section::Support", "name" : "Support", "version" : "1.014" } ] } }, "name" : "@Filter/PodWeaver", "version" : "4.010" }, { "class" : "Dist::Zilla::Plugin::UploadToCPAN", "name" : "@Filter/UploadToCPAN", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":InstallModules", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":IncModules", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":TestFiles", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExtraTestFiles", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExecFiles", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":PerlExecFiles", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ShareFiles", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":MainModule", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":AllFiles", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":NoFiles", "version" : "6.030" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : "@Filter/MetaProvides::Package/AUTOVIV/:InstallModulesPM", "version" : "6.030" } ], "zilla" : { "class" : "Dist::Zilla::Dist::Builder", "config" : { "is_trial" : 0 }, "version" : "6.030" } }, "x_generated_by_perl" : "v5.36.1", "x_serialization_backend" : "Cpanel::JSON::XS version 4.35", "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" } README.pod100644000764000764 2535514460147160 20620 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014=pod =encoding UTF-8 =for :stopwords Apocalypse cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan dist dzil repo =for Pod::Coverage weave_section mvp_multivalue_args =head1 NAME Pod::Weaver::Section::Support - Add a SUPPORT section to your POD =head1 VERSION This document describes v1.007 of Pod::Weaver::Section::Support - released November 04, 2014 as part of Pod-Weaver-Section-Support. =head1 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 L because it needs the data from the dzil object. If you have L enabled in your F, be sure to check the repository_link attribute! This is added B 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 L section in this POD :) =head1 ATTRIBUTES =head2 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. =head2 perldoc Specify if you want the paragraph explaining about perldoc to be displayed or not. The default is true. =head2 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 L 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". =head2 bugs_content Specify the content for the bugs section. Please put the "{EMAIL}" and "{WEB}" placeholders somewhere! The default is a sufficient explanation (see L). =head2 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! =head2 websites_content Specify the content to be displayed before the website list. The default is a sufficient explanation (see L). =head2 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 L. 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 =head2 irc_content Specify the content to be displayed before the irc network/channel list. The default is a sufficient explanation (see L). =head2 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. =head2 repository_content Specify the content to be displayed before the link to the source code repository. The default is a sufficient explanation (see L). =head2 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. =head2 email_content Specify the content for the email section. Please put the "{EMAIL}" placeholder somewhere! The default is a sufficient explanation ( see L). =head1 SUPPORT =head2 Perldoc You can find documentation for this module with the perldoc command. perldoc Pod::Weaver::Section::Support =head2 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. =over 4 =item * MetaCPAN A modern, open-source CPAN search engine, useful to view POD in HTML format. L =item * Search CPAN The default CPAN search engine, useful to view POD in HTML format. L =item * RT: CPAN's Bug Tracker The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN. L =item * AnnoCPAN The AnnoCPAN is a website that allows community annotations of Perl module documentation. L =item * CPAN Ratings The CPAN Ratings is a website that allows community ratings and reviews of Perl modules. L =item * CPAN Forum The CPAN Forum is a web forum for discussing Perl modules. L =item * CPANTS The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution. L =item * CPAN Testers The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions. L =item * 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. L =item * CPAN Testers Dependencies The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. L =back =head2 Email You can email the author of this module at C asking for help with any problems you have. =head2 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: L. 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: =over 4 =item * 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. =item * 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. =item * 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. =back =head2 Bugs / Feature Requests Please report any bugs or feature requests by email to C, or through the web interface at L. You will be automatically notified of any progress on the request by the system. =head2 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 :) L git clone https://github.com/apocalypse/perl-pod-weaver-section-support.git =head1 AUTHOR Apocalypse =head2 CONTRIBUTORS =for stopwords Alex Peters Kent Fredric Randy Stauner =over 4 =item * Alex Peters =item * Kent Fredric =item * Randy Stauner =back =head1 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 F file included with this distribution. =head1 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. =cut weaver.ini100644000764000764 66514460147160 21106 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014[@CorePrep] [-SingleEncoding] [Generic / NAME] [Version] [Region / prelude] [Generic / SYNOPSIS] [Generic / DESCRIPTION] [Generic / OVERVIEW] [Collect / ATTRIBUTES] command = attr [Collect / METHODS] command = method [Leftovers] [Region / postlude] [Authors] [Legal] ; [Generic / DESCRIPTION] ; required = 1 ; [Generic / BUGS] ; [Generic / Section::Bugs] ; [Generic / Section::License] ; [Bugs] [Support] all_modules = 1 Makefile.PL100644000764000764 315414460147160 21102 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.030. use strict; use warnings; use 5.006; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "Add a SUPPORT section to your POD", "AUTHOR" => "Shlomi Fish ", "BUILD_REQUIRES" => { "Module::Build" => "0.28" }, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "Module::Build" => "0.28" }, "DISTNAME" => "Pod-Weaver-Section-Support", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.006", "NAME" => "Pod::Weaver::Section::Support", "PREREQ_PM" => { "Moose" => "1.03", "Moose::Util::TypeConstraints" => "1.01", "PPIx::DocumentName" => 0, "Pod::Weaver::Role::Section" => "3.100710", "strict" => 0 }, "TEST_REQUIRES" => { "File::Spec" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Test::More" => "0.88", "warnings" => 0 }, "VERSION" => "1.014", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "File::Spec" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Module::Build" => "0.28", "Moose" => "1.03", "Moose::Util::TypeConstraints" => "1.01", "PPIx::DocumentName" => 0, "Pod::Weaver::Role::Section" => "3.100710", "Test::More" => "0.88", "strict" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); appveyor.yml100644000764000764 200014460147160 21505 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014--- # Shamelessly taken from https://github.com/plicease/Dist-Zilla-PluginBundle-Author-Plicease/blob/master/.appveyor.yml # Thanks! install: - choco install strawberryperl - SET PATH=C:\strawberry\c\bin;C:\strawberry\perl\site\bin;C:\strawberry\perl\bin;%PATH% - perl -v - if not exist C:\Perl5 mkdir C:\Perl5 - SET PATH=C:\Perl5\bin;C:\strawberry\c\bin;C:\strawberry\perl\site\bin;C:\strawberry\perl\bin;%PATH% - SET PERL5LIB=C:/Perl5/lib/perl5 - SET PERL_LOCAL_LIB_ROOT=C:/Perl5 - SET PERL_MB_OPT=--install_base C:/Perl5 - SET PERL_MM_OPT=INSTALL_BASE=C:/Perl5 - cpanm -n Dist::Zilla - cpanm -n Dist::Zilla::Plugin::PodWeaver - cpanm -n Pod::Coverage::TrustPod - cpanm -n Pod::Weaver::Section::Support - cpanm -n Test::EOL - cpanm -n Test::Pod - cpanm -n Test::Pod::Coverage - dzil authordeps --missing | cpanm -n - dzil listdeps --missing | cpanm -n build: off test_script: - dzil test -v --all cache: - C:\Perl5 shallow_clone: true MANIFEST.SKIP100644000764000764 1614460147160 20760 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014^releases/ ~$ t000755000764000764 014460147160 17230 5ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.01400-compile.t100644000764000764 265314460147160 21430 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/tuse 5.006; use strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::Compile 2.058 use Test::More; plan tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0); my @module_files = ( 'Pod/Weaver/Section/Support.pm' ); # no fake home requested my @switches = ( -d 'blib' ? '-Mblib' : '-Ilib', ); use File::Spec; use IPC::Open3; use IO::Handle; open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; my @warnings; for my $lib (@module_files) { # see L my $stderr = IO::Handle->new; diag('Running: ', join(', ', map { my $str = $_; $str =~ s/'/\\'/g; q{'} . $str . q{'} } $^X, @switches, '-e', "require q[$lib]")) if $ENV{PERL_COMPILE_TEST_DEBUG}; my $pid = open3($stdin, '>&STDERR', $stderr, $^X, @switches, '-e', "require q[$lib]"); binmode $stderr, ':crlf' if $^O eq 'MSWin32'; my @_warnings = <$stderr>; waitpid($pid, 0); is($?, 0, "$lib loaded ok"); shift @_warnings if @_warnings and $_warnings[0] =~ /^Using .*\bblib/ and not eval { +require blib; blib->VERSION('1.01') }; if (@_warnings) { warn @_warnings; push @warnings, @_warnings; } } is(scalar(@warnings), 0, 'no warnings found') or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ) if $ENV{AUTHOR_TESTING}; author000755000764000764 014460147160 20722 5ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/xteol.t100644000764000764 44014460147160 22004 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/xt/authoruse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::EOL 0.19 use Test::More 0.88; use Test::EOL; my @files = ( 'lib/Pod/Weaver/Section/Support.pm', 't/00-compile.t' ); eol_unix_ok($_, { trailing_whitespace => 1 }) foreach @files; done_testing; examples000755000764000764 014460147160 20603 5ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014weaver.ini100644000764000764 2514460147160 22672 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/examples[@Default] [Support] pod-syntax.t100644000764000764 25214460147160 23334 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/xt/author#!perl # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use strict; use warnings; use Test::More; use Test::Pod 1.41; all_pod_files_ok(); pod-coverage.t100644000764000764 36514460147160 23606 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/xt/author#!perl # This file was automatically generated by Dist::Zilla::Plugin::PodCoverageTests. use strict; use warnings; use Test::Pod::Coverage 1.08; use Pod::Coverage::TrustPod; all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); release000755000764000764 014460147160 21040 5ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/xtcpan-changes.t100644000764000764 34414460147160 23675 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/xt/releaseuse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::CPAN::Changes 0.012 use Test::More 0.96 tests => 1; use Test::CPAN::Changes; subtest 'changes_ok' => sub { changes_file_ok('Changes'); }; trailing-space.t100644000764000764 103414460147160 24265 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/xt/release#!perl use strict; use warnings; use Test::More; eval "use Test::TrailingSpace"; if ($@) { plan skip_all => "Test::TrailingSpace required for trailing space test."; } else { plan tests => 1; } # TODO: add .pod, .PL, the README/Changes/TODO/etc. documents and possibly # some other stuff. my $finder = Test::TrailingSpace->new( { root => '.', filename_regex => qr#(?:\.(?:t|pm|pl|xs|c|h|txt|pod|PL)|README|Changes|TODO|LICENSE)\z#, }, ); # TEST $finder->no_trailing_space( "No trailing space was found." ); Section000755000764000764 014460147160 23112 5ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/lib/Pod/WeaverSupport.pm100644000764000764 6715214460147160 25317 0ustar00shlomifshlomif000000000000Pod-Weaver-Section-Support-1.014/lib/Pod/Weaver/Sectionpackage Pod::Weaver::Section::Support; $Pod::Weaver::Section::Support::VERSION = '1.014'; # ABSTRACT: Add a SUPPORT section to your POD use Moose 1.03; use PPIx::DocumentName; with 'Pod::Weaver::Role::Section' => { -version => '3.100710' }; sub mvp_multivalue_args { qw( websites irc bugs_content email_content irc_content repository_content websites_content ); } has all_modules => ( is => 'ro', isa => 'Bool', default => 0, ); has perldoc => ( is => 'ro', isa => 'Bool', default => 1, ); { use Moose::Util::TypeConstraints 1.01; has bugs => ( is => 'ro', isa => enum( [qw( rt metadata none )] ), default => 'rt', ); no Moose::Util::TypeConstraints; } has bugs_content => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [ <<'EOPOD', Please report any bugs or feature requests by email to {EMAIL}, or through the web interface at {WEB}. You will be automatically notified of any progress on the request by the system. EOPOD ]; }, ); # TODO how do I Moosify this into a fancy type system where it coerces from CSV strings and bla bla? has websites => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { ['all'] }, ); has websites_content => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [ <<'EOPOD', 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. EOPOD ]; }, ); has irc => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [] }, ); has irc_content => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [ <<'EOPOD', You can get live help by using IRC ( Internet Relay Chat ). If you don't know what IRC is, please read this excellent guide: L. 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: EOPOD ]; }, ); { use Moose::Util::TypeConstraints 1.01; has repository_link => ( is => 'ro', isa => enum( [qw( both none url web )] ), default => 'both', ); no Moose::Util::TypeConstraints; } has repository_content => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [ <<'EOPOD', 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 :) EOPOD ]; }, ); has email => ( is => 'ro', isa => 'Maybe[Str]', default => undef, ); has email_content => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [ <<'EOPOD', You can email the author of this module at {EMAIL} asking for help with any problems you have. EOPOD ]; }, ); sub weave_section { ## no critic ( ProhibitAccessOfPrivateData ) my ( $self, $document, $input ) = @_; my $zilla = $input->{zilla} or die 'Please use Dist::Zilla with this module!'; # Is this the main module POD? if ( !$self->all_modules ) { return if $zilla->main_module->name ne $input->{filename}; } # Add the stopwords so the spell checker won't complain! # TODO make this smarter so it loads only the stopwords we need for specific sections... ohwell push @{ $document->children }, Pod::Elemental::Element::Pod5::Region->new( { format_name => 'stopwords', is_pod => 1, content => '', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => join( " ", qw( cpan testmatrix url bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan ) ), } ), ], } ), Pod::Elemental::Element::Nested->new( { command => 'head1', content => 'SUPPORT', children => [ $self->_add_perldoc( $input->{ppi_document} ), $self->_add_websites($zilla), $self->_add_email($zilla), $self->_add_irc($zilla), $self->_add_bugs( $zilla, $input->{'distmeta'} ), $self->_add_repo($zilla), ], } ); } sub _add_email { my $self = shift; # Do we have anything to do? return () if !defined $self->email; # pause id for email? my $address = $self->email; if ( $address !~ /\@/ ) { $address = 'C<' . uc($address) . ' at cpan.org>'; } else { $address = "C<$address>"; } my $content = join( "\n", @{ $self->email_content } ); $content =~ s/\{EMAIL\}/$address/; return Pod::Elemental::Element::Nested->new( { command => 'head2', content => 'Email', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => $content, } ), ], } ); } sub _add_bugs { my ( $self, $zilla, $distmeta ) = @_; # Do we have anything to do? return () if $self->bugs eq 'none'; # Which kind of text should we display? my $text = join( "\n", @{ $self->bugs_content } ); if ( $self->bugs eq 'rt' ) { my $dist = $zilla->name; my $mailto = "C"; my $web = "L"; $text =~ s/\{WEB\}/$web/; $text =~ s/\{EMAIL\}/$mailto/; } else { # code copied from Pod::Weaver::Section::Bugs, thanks RJBS! $self->log_fatal('No bugtracker in metadata!') unless exists $distmeta->{resources}{bugtracker}; my $bugtracker = $distmeta->{resources}{bugtracker}; my ( $web, $mailto ) = @{$bugtracker}{qw/web mailto/}; $self->log_fatal('No bugtracker in metadata!') unless defined $web || defined $mailto; $text =~ s/\{WEB\}/L\<$web\>/ if defined $web; $text =~ s/\{EMAIL\}/C\<$mailto\>/ if defined $mailto; # sanity check the content if ( $text =~ /\{WEB\}/ ) { $self->log_fatal( "The metadata doesn't have a website for the bugtracker but you specified it in the bugs_content!" ); } if ( $text =~ /\{EMAIL\}/ ) { $self->log_fatal( "The metadata doesn't have an email for the bugtracker but you specified it in the bugs_content!" ); } } return Pod::Elemental::Element::Nested->new( { command => 'head2', content => 'Bugs / Feature Requests', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => $text, } ), ], } ); } sub _add_perldoc { my ( $self, $ppi_doc ) = @_; # Do we have anything to do? return () if !$self->perldoc; # Get the name for the module my $module = PPIx::DocumentName->extract($ppi_doc); # Avoid trailing space and an empty directive return () if !length $module; # TODO add language detection as per RT#63726 return Pod::Elemental::Element::Nested->new( { command => 'head2', content => 'Perldoc', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => <<'EOPOD', You can find documentation for this module with the perldoc command. EOPOD } ), Pod::Elemental::Element::Pod5::Verbatim->new( { content => " perldoc $module", } ), ], } ); } sub _add_irc { my $self = shift; my $zilla = shift; my @irc; # thanks to https://metacpan.org/about/metadata for the info! if ( scalar @{ $self->irc } ) { $self->log( 'IRC was set twice: in the metadata and in this plugin, overriding the metadata!' ) if exists $zilla->distmeta->{'x_IRC'}; @irc = @{ $self->irc }; } elsif ( exists $zilla->distmeta->{'x_IRC'} ) { my $x_irc = $zilla->distmeta->{'x_IRC'}; if ( ref $x_irc ) { # handle the newer url/web nested spec $x_irc = $x_irc->{'url'}; } if ( $x_irc =~ m|^irc://([^/]+)/(.+)$| ) { push( @irc, "$1,$2" ); } else { $self->log( "Error: the IRC metadata needs to be in the proper format: 'irc://servername.com/#room' but yours was: $x_irc" ); return (); } } else { return (); } my @networks; foreach my $entry (@irc) { my ( $net, @chans, @nicks ); if ( $entry =~ m|^irc://([^/]+)/(.+)$| ) { $net = $1; push( @chans, $2 ); } else { # Split it into fields my @data = split( /\,/, $entry ); $_ =~ s/^\s+//g for @data; $_ =~ s/\s+$//g for @data; # Add the network data! $net = shift @data; foreach my $e (@data) { if ( $e =~ /^\#/ ) { push( @chans, $e ); } else { push( @nicks, $e ); } } } my $text = "You can connect to the server at '$net'"; if (@chans) { if ( @chans > 1 ) { $text .= " and join those channels: "; $text .= join( ' , ', @chans ); } else { $text .= " and join this channel: $chans[0]"; } } if (@nicks) { if (@chans) { $text .= " then"; } else { $text .= " and"; } if ( @nicks > 1 ) { $text .= " talk to those people for help: "; $text .= join( ' , ', @nicks ); } else { $text .= " talk to this person for help: $nicks[0]"; } } if ( !@nicks ) { $text .= " to get help"; } $text .= '.'; push( @networks, _make_item( $net, $text ) ); } return Pod::Elemental::Element::Nested->new( { command => 'head2', content => 'Internet Relay Chat', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => join( "\n", @{ $self->irc_content } ), } ), Pod::Elemental::Element::Nested->new( { command => 'over', content => '4', children => [ @networks, Pod::Elemental::Element::Pod5::Command->new( { command => 'back', content => '', } ), ], } ), ], } ); } sub _add_repo { my ( $self, $zilla ) = @_; # Do we have anything to do? return () if $self->repository_link eq 'none'; my $repo; if ( exists $zilla->distmeta->{resources}{repository} ) { $repo = $zilla->distmeta->{resources}{repository}; } else { $self->log_fatal( [ "Repository information in meta.resources.repository is missing and you wanted: %s", $self->repository_link eq 'both' ? 'both (web and url)' : $self->repository_link, ] ); } my $text = join( "\n", @{ $self->repository_content } ); $text .= "\n"; # for the links to be appended # for dzil v3 with CPAN Meta v2 if ( ref $repo ) { # add the web url? if ( $self->repository_link eq 'web' or $self->repository_link eq 'both' ) { if ( exists $repo->{web} ) { $text .= 'L<' . $repo->{web} . ">"; } else { $self->log_fatal( "Expected to find 'web' repository link but it is missing in the metadata!" ); } } if ( $self->repository_link eq 'url' or $self->repository_link eq 'both' ) { if ( !exists $repo->{url} ) { $self->log_fatal( "Expected to find 'url' repository link but it is missing in the metadata!" ); } if ( $self->repository_link eq 'both' ) { $text .= "\n\n"; } # do we have a type? $text .= ' '; if ( exists $repo->{type} ) { # list of repo types taken from Dist::Zilla::Plugin::Repository v0.16 if ( $repo->{type} eq 'git' ) { $text .= 'git clone'; } elsif ( $repo->{type} eq 'svn' ) { $text .= 'svn checkout'; } elsif ( $repo->{type} eq 'darcs' ) { $text .= 'darcs get'; } elsif ( $repo->{type} eq 'hg' ) { $text .= 'hg clone'; } else { # TODO add support for other formats? cvs/bzr? they're not in DZP::Repository... } $text .= ' ' . $repo->{url}; } else { $text .= $repo->{url}; } } } else { $self->log_warning( "You need to update Dist::Zilla::Plugin::Repository to at least v0.15 for the correct metadata!" ); $text .= "L<$repo>"; } return Pod::Elemental::Element::Nested->new( { command => 'head2', content => 'Source Code', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => $text, } ), ], } ); } sub _add_websites { my ( $self, $zilla ) = @_; # Do we have anything to do? return () if !scalar @{ $self->websites }; return () if grep { $_ eq 'none' } @{ $self->websites } ; ## no critic ( BuiltinFunctions::ProhibitBooleanGrep ) # explode CSV lists my @newlist; foreach my $w ( @{ $self->websites } ) { if ( $w =~ /,/ ) { my @list = split( /\,/, $w ); $_ =~ s/^\s+//g for @list; $_ =~ s/\s+$//g for @list; push( @newlist, @list ); } else { $w =~ s/^\s+//g; $w =~ s/\s+$//g; push( @newlist, $w ); } } @{ $self->websites } = @newlist; # sanity check foreach my $type ( @{ $self->websites } ) { if ( $type !~ /^(?:metacpan|search|rt|ratings|kwalitee|testers|testmatrix|deps|all)$/i ) { $self->log_fatal("Unknown website type: $type"); } } # Set the default ordering for "all" if ( grep { $_ eq 'all' } @{ $self->websites } ) { ## no critic ( BuiltinFunctions::ProhibitBooleanGrep ) @{ $self->websites } = qw( metacpan rt kwalitee testers testmatrix deps ); } # Make the website links! my @links; my %seen_type; foreach my $type ( @{ $self->websites } ) { next if $seen_type{$type}++; $type = '_add_websites_' . $type; my $main_module = $zilla->main_module->name; $main_module =~ s|^lib/||i; $main_module =~ s/\.pm$//; $main_module =~ s|/|::|g; # TODO I'm too lazy to build a proper dispatch table... no strict 'refs'; push( @links, &$type( $zilla->name, $main_module ) ); } return Pod::Elemental::Element::Nested->new( { command => 'head2', content => 'Websites', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => join( "\n", @{ $self->websites_content } ), } ), Pod::Elemental::Element::Nested->new( { command => 'over', content => '4', children => [ @links, Pod::Elemental::Element::Pod5::Command->new( { command => 'back', content => '', } ), ], } ), ], } ); } sub _add_websites_metacpan { my $dist = shift; return _make_item( 'MetaCPAN', <<"EOF" ); A modern, open-source CPAN search engine, useful to view POD in HTML format. L EOF } sub _add_websites_search { # See https://github.com/shlomif/HTML-Spelling-Site/issues/2 . return; } sub _add_websites_rt { my $dist = shift; return _make_item( "RT: CPAN's Bug Tracker", <<"EOF" ); The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN. L EOF } sub _add_websites_ratings { # See https://github.com/shlomif/HTML-Spelling-Site/issues/2 . return; } sub _add_websites_kwalitee { my $dist = shift; return _make_item( 'CPANTS', <<"EOF" ); The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution. L EOF } sub _add_websites_testers { my $dist = shift; my $first_char = substr( $dist, 0, 1 ); return _make_item( 'CPAN Testers', <<"EOF" ); The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions. L EOF } sub _add_websites_testmatrix { my $dist = shift; return _make_item( 'CPAN Testers Matrix', <<"EOF" ); The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms. L EOF } sub _add_websites_deps { my $module = $_[1]; return _make_item( 'CPAN Testers Dependencies', <<"EOF" ); The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. L EOF } sub _make_item { my ( $title, $contents ) = @_; my $str = $title; if ( defined $contents ) { $str .= "\n\n$contents"; } return Pod::Elemental::Element::Nested->new( { command => 'item', content => '*', children => [ Pod::Elemental::Element::Pod5::Ordinary->new( { content => $str, } ), ], } ); } 1; __END__ =pod =encoding UTF-8 =head1 NAME Pod::Weaver::Section::Support - Add a SUPPORT section to your POD =head1 VERSION version 1.014 =head1 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 L because it needs the data from the dzil object. If you have L enabled in your F, be sure to check the repository_link attribute! This is added B 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 L section in this POD :) =head1 ATTRIBUTES =head2 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. =head2 perldoc Specify if you want the paragraph explaining about perldoc to be displayed or not. The default is true. =head2 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 L 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". =head2 bugs_content Specify the content for the bugs section. Please put the "{EMAIL}" and "{WEB}" placeholders somewhere! The default is a sufficient explanation (see L). =head2 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", "rt", "kwalitee", "testers", "testmatrix", "deps" and "all". The default is "all". # Where the links go to: metacpan - https://metacpan.org/release/$dist rt - https://rt.cpan.org/Public/Dist/Display.html?Name=$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 = metacpan websites = testers , testmatrix P.S. If you know other websites that I should include here, please let me know! =head2 websites_content Specify the content to be displayed before the website list. The default is a sufficient explanation (see L). =head2 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 L. 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 =head2 irc_content Specify the content to be displayed before the irc network/channel list. The default is a sufficient explanation (see L). =head2 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. =head2 repository_content Specify the content to be displayed before the link to the source code repository. The default is a sufficient explanation (see L). =head2 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. =head2 email_content Specify the content for the email section. Please put the "{EMAIL}" placeholder somewhere! The default is a sufficient explanation ( see L). =for stopwords dist dzil repo =for Pod::Coverage weave_section mvp_multivalue_args =head1 AUTHOR Shlomi Fish =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2010 by Apocalyptic. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =head1 BUGS Please report any bugs or feature requests on the bugtracker website L When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. =for :stopwords cpan testmatrix url bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan =head1 SUPPORT =head2 Perldoc You can find documentation for this module with the perldoc command. perldoc Pod::Weaver::Section::Support =head2 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. =over 4 =item * MetaCPAN A modern, open-source CPAN search engine, useful to view POD in HTML format. L =item * RT: CPAN's Bug Tracker The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN. L =item * CPANTS The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution. L =item * CPAN Testers The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions. L =item * 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. L =item * CPAN Testers Dependencies The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. L =back =head2 Bugs / Feature Requests Please report any bugs or feature requests by email to C, or through the web interface at L. You will be automatically notified of any progress on the request by the system. =head2 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 :) L git clone https://github.com/shlomif/perl-pod-weaver-section-support =cut