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.018
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 has the same support period as perl itself: it supports
26 the two most recent versions of perl. (That is, if the most recently
27 released version is v5.40, then this module should work on both v5.40
28 and v5.38.)
29
30 Although it may work on older versions of perl, no guarantee is made
31 that the minimum required version will not be increased. The version
32 may be increased for any reason, and there is no promise that patches
33 will be accepted to lower the minimum required perl.
34
36 command
37 The command that will be collected (e.g. "attr" or "method").
38 (required)
39
40 new_command
41 The command to be used in the output instead of the collected command.
42 (default: "head2")
43
44 header_command
45 The section command for the section to be added. (default: "head1")
46
47 header
48 The title of the section to be added. (default: the plugin name)
49
51 Ricardo SIGNES <rjbs@semiotic.systems>
52
54 This software is copyright (c) 2021 by Ricardo SIGNES.
55
56 This is free software; you can redistribute it and/or modify it under
57 the same terms as the Perl 5 programming language system itself.
58
59
60
61perl v5.34.0 2021-07-22 Pod::Weaver::Section::Collect(3)