1Pod::Weaver::Section::CUoslelrecCto(n3t)ributed Perl DocPuomde:n:tWaetaivoenr::Section::Collect(3)
2
3
4
6 Pod::Weaver::Section::Collect - a section that gathers up specific
7 commands
8
10 version 4.019
11
13 Given the configuration:
14
15 [Collect / METHODS]
16 command = method
17
18 This plugin will start off by gathering and nesting any "=method"
19 commands found in the "pod_document". Those commands, along with their
20 nestable content, will be collected under a "=head1 METHODS" header and
21 placed in the correct location in the output stream. Their order will
22 be preserved as it was in the source document.
23
25 This module should work on any version of perl still receiving updates
26 from the Perl 5 Porters. This means it should work on any version of
27 perl released in the last two to three years. (That is, if the most
28 recently released version is v5.40, then this module should work on
29 both v5.40 and v5.38.)
30
31 Although it may work on older versions of perl, no guarantee is made
32 that the minimum required version will not be increased. The version
33 may be increased for any reason, and there is no promise that patches
34 will be accepted to lower the minimum required perl.
35
37 command
38 The command that will be collected (e.g. "attr" or "method").
39 (required)
40
41 new_command
42 The command to be used in the output instead of the collected command.
43 (default: "head2")
44
45 header_command
46 The section command for the section to be added. (default: "head1")
47
48 header
49 The title of the section to be added. (default: the plugin name)
50
52 Ricardo SIGNES <cpan@semiotic.systems>
53
55 This software is copyright (c) 2023 by Ricardo SIGNES.
56
57 This is free software; you can redistribute it and/or modify it under
58 the same terms as the Perl 5 programming language system itself.
59
60
61
62perl v5.36.0 2023-01-12 Pod::Weaver::Section::Collect(3)