Pod::Weaver::Section::Contributors(3pm)

Usage

on dist.ini:

    [PodWeaver]
    [%PodWeaver]
    Contributors.head = 2
    Contributors.contributors[0] = keedi - Keedi Kim - 김도형 (cpan: KEEDI) <[email protected]>
    Contributors.contributors[1] = carandraug - Carnë Draug (cpan: CDRAUG) <[email protected]>

and/or weaver.ini:

    [Contributors]
    head = 2
    contributors = keedi - Keedi Kim - 김도형 (cpan: KEEDI) <[email protected]>
    contributors = carandraug - Carnë Draug (cpan: CDRAUG) <[email protected]>

and/or in the source of individual files:

    # CONTRIBUTOR:  keedi - Keedi Kim - 김도형 (cpan: KEEDI) <[email protected]>
    # CONTRIBUTORS: carandraug - Carnë Draug (cpan: CDRAUG) <[email protected]>

Version

version 0.009

Overview

This section adds a listing of the documents contributors. It expects a "contributors" input parameter to be an arrayref of strings. If no "contributors" parameter is given, it will do nothing. Otherwise, it produces a hunk like this:

    =head1 CONTRIBUTORS
    Contributor One <[email protected]>
    Contributor Two <[email protected]>

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.

Contributors

`•`	carandraug - Carnë Draug (cpan: CDRAUG) <[email protected]>
`•`	ether - Karen Etheridge (cpan: ETHER) <[email protected]>
`•`	thaljef - Jeffrey Ryan Thalhammer (cpan: THALJEF) <[email protected]>

Copyright and license

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Releases

4 releases since Debian 10 (Buster); the text changed 2 times.