1Pod::Weaver::Section::VUesresrioCno(n3t)ributed Perl DocPuomde:n:tWaetaivoenr::Section::Version(3)
2
3
4

NAME

6       Pod::Weaver::Section::Version - add a VERSION pod section
7

VERSION

9       version 4.019
10

OVERVIEW

12       This section plugin will produce a hunk of Pod meant to indicate the
13       version of the document being viewed, like this:
14
15         =head1 VERSION
16
17         version 1.234
18
19       It will do nothing if there is no "version" entry in the input.
20

PERL VERSION

22       This module should work on any version of perl still receiving updates
23       from the Perl 5 Porters.  This means it should work on any version of
24       perl released in the last two to three years.  (That is, if the most
25       recently released version is v5.40, then this module should work on
26       both v5.40 and v5.38.)
27
28       Although it may work on older versions of perl, no guarantee is made
29       that the minimum required version will not be increased.  The version
30       may be increased for any reason, and there is no promise that patches
31       will be accepted to lower the minimum required perl.
32

ATTRIBUTES

34   header
35       The title of the header to be added.  (default: "VERSION")
36
37   format
38       The string to use when generating the version string.
39
40       Default: version %v
41
42       The following variables are available:
43
44       •   v - the version
45
46       •   V - the version, suffixed by "-TRIAL" if a trial release
47
48       •   d - the CLDR format for DateTime
49
50       •   n - a newline
51
52       •   t - a tab
53
54       •   s - a space
55
56       •   r - the name of the dist, present only if you use Dist::Zilla to
57           generate the POD!
58
59       •   m - the name of the module, present only if PPI parsed the document
60           and it contained a package declaration!
61
62       •   T - special: at the beginning of the line, followed by any amount
63           of whitespace, indicates that the line should only be included in
64           trial releases; otherwise, results in a fatal error
65
66       If multiple strings are supplied as an array ref, a line of POD is
67       produced for each string.  Each line will be separated by a newline.
68       This is useful for splitting longer text across multiple lines in a
69       "weaver.ini" file, for example:
70
71         ; weaver.ini
72         [Version]
73         format = version %v
74         format =
75         format = This module's version numbers follow the conventions described at
76         format = L<semver.org|http://semver.org/>.
77         format = %T
78         format = %T This is a trial release!
79
80   is_verbatim
81       A boolean value specifying whether the version paragraph should be
82       verbatim or not.
83
84       Default: false
85
86   time_zone
87       The timezone to use when using DateTime for the format.
88
89       Default: local
90

METHODS

92   build_content
93         my @pod_elements = $section->build_content(\%input);
94
95       This method is passed the same "\%input" that goes to the
96       "weave_section" method, and should return a list of pod elements to
97       insert.
98
99       In almost all cases, this method is used internally, but could be
100       usefully overridden in a subclass.
101

AUTHOR

103       Ricardo SIGNES <cpan@semiotic.systems>
104

106       This software is copyright (c) 2023 by Ricardo SIGNES.
107
108       This is free software; you can redistribute it and/or modify it under
109       the same terms as the Perl 5 programming language system itself.
110
111
112
113perl v5.36.0                      2023-01-12  Pod::Weaver::Section::Version(3)
Impressum