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.017
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

ATTRIBUTES

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

METHODS

80   build_content
81         my @pod_elements = $section->build_content(\%input);
82
83       This method is passed the same "\%input" that goes to the
84       "weave_section" method, and should return a list of pod elements to
85       insert.
86
87       In almost all cases, this method is used internally, but could be
88       usefully overridden in a subclass.
89

AUTHOR

91       Ricardo SIGNES <rjbs@cpan.org>
92

94       This software is copyright (c) 2021 by Ricardo SIGNES.
95
96       This is free software; you can redistribute it and/or modify it under
97       the same terms as the Perl 5 programming language system itself.
98
99
100
101perl v5.32.1                      2021-04-19  Pod::Weaver::Section::Version(3)
Impressum