-
-
22 Dec 2014 02:53:34 UTC
- Distribution: Pod-Weaver-Section-Contributors
- Module version: 0.009
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (1)
- Testers (4058 / 0 / 0)
- Kwalitee
Bus factor: 1- % Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (12.59KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
NAME
Pod::Weaver::Section::Contributors - a section listing contributors
VERSION
version 0.009
SYNOPSIS
on dist.ini:
[PodWeaver] [%PodWeaver] Contributors.head = 2 Contributors.contributors[0] = keedi - Keedi Kim - 김도형 (cpan: KEEDI) <keedi@cpan.org> Contributors.contributors[1] = carandraug - Carnë Draug (cpan: CDRAUG) <cdraug@cpan.org>
and/or weaver.ini:
[Contributors] head = 2 contributors = keedi - Keedi Kim - 김도형 (cpan: KEEDI) <keedi@cpan.org> contributors = carandraug - Carnë Draug (cpan: CDRAUG) <cdraug@cpan.org>
and/or in the source of individual files:
# CONTRIBUTOR: keedi - Keedi Kim - 김도형 (cpan: KEEDI) <keedi@cpan.org> # CONTRIBUTORS: carandraug - Carnë Draug (cpan: CDRAUG) <cdraug@cpan.org>
DESCRIPTION
This section adds a listing of the documents contributors. It expects a
contributors
input parameter to be an arrayref of strings. If nocontributors
parameter is given, it will do nothing. Otherwise, it produces a hunk like this:=head1 CONTRIBUTORS Contributor One <a1@example.com> Contributor Two <a2@example.com>
To support distributions with multiple modules, it is also able to derive a list of contributors in a file basis by looking at comments on each module. Names of contributors on the source, will only appear on the POD of those modules.
ATTRIBUTES
head
The heading level of this section. If 0, it inserts an ordinary piece of text with no heading. Defaults to 1.
In case the value is passed both to Pod::Weaver and to the Pod::Weaver stash, it uses the value found in the stash.
contributors
The list of contributors.
In case the value is passed to
weave_section()
, to Pod::Weaver and to the Pod::Weaver stash, it merges all contributors.all_modules
Enable this if you want to add the CONTRIBUTOR/CONTRIBUTORS section to all the modules in a dist, not only the main one. Defaults to false.
In case the value is passed both to Pod::Weaver and to the Pod::Weaver stash, it uses the value found in the stash.
SEE ALSO
AUTHOR
Keedi Kim - 김도형 <keedi@cpan.org>
CONTRIBUTORS
carandraug - Carnë Draug (cpan: CDRAUG) <cdraug@cpan.org>
ether - Karen Etheridge (cpan: ETHER) <ether@cpan.org>
thaljef - Jeffrey Ryan Thalhammer (cpan: THALJEF) <thaljef@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Keedi Kim.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Module Install Instructions
To install Pod::Weaver::Section::Contributors, copy and paste the appropriate command in to your terminal.
cpanm Pod::Weaver::Section::Contributors
perl -MCPAN -e shell install Pod::Weaver::Section::Contributors
For more information on module installation, please visit the detailed CPAN module installation guide.