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.018
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 SUPPORT

22       This module has the same support period as perl itself:  it supports
23       the two most recent versions of perl.  (That is, if the most recently
24       released version is v5.40, then this module should work on both v5.40
25       and v5.38.)
26
27       Although it may work on older versions of perl, no guarantee is made
28       that the minimum required version will not be increased.  The version
29       may be increased for any reason, and there is no promise that patches
30       will be accepted to lower the minimum required perl.
31

ATTRIBUTES

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

METHODS

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

AUTHOR

102       Ricardo SIGNES <rjbs@semiotic.systems>
103

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