.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Weaver::Section::Version 3pm"
.TH Pod::Weaver::Section::Version 3pm 2024-03-24 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Pod::Weaver::Section::Version \- add a VERSION pod section
.SH VERSION
.IX Header "VERSION"
version 4.020
.SH OVERVIEW
.IX Header "OVERVIEW"
This section plugin will produce a hunk of Pod meant to indicate the version of
the document being viewed, like this:
.PP
.Vb 1
\&  =head1 VERSION
\&
\&  version 1.234
.Ve
.PP
It will do nothing if there is no \f(CW\*(C`version\*(C'\fR entry in the input.
.SH "PERL VERSION"
.IX Header "PERL VERSION"
This module should work on any version of perl still receiving updates from
the Perl 5 Porters.  This means it should work on any version of perl
released in the last two to three years.  (That is, if the most recently
released version is v5.40, then this module should work on both v5.40 and
v5.38.)
.PP
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased.  The version may be increased
for any reason, and there is no promise that patches will be accepted to
lower the minimum required perl.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS header
.IX Subsection "header"
The title of the header to be added.
(default: "VERSION")
.SS format
.IX Subsection "format"
The string to use when generating the version string.
.PP
Default: version \f(CW%v\fR
.PP
The following variables are available:
.IP \(bu 4
v \- the version
.IP \(bu 4
V \- the version, suffixed by "\-TRIAL" if a trial release
.IP \(bu 4
d \- the CLDR format for DateTime
.IP \(bu 4
n \- a newline
.IP \(bu 4
t \- a tab
.IP \(bu 4
s \- a space
.IP \(bu 4
r \- the name of the dist, present only if you use Dist::Zilla to generate the POD!
.IP \(bu 4
m \- the name of the module, present only if PPI parsed the document and it contained a package declaration!
.IP \(bu 4
T \- special: at the beginning of the line, followed by any amount of whitespace, indicates that the line should only be included in trial releases; otherwise, results in a fatal error
.PP
If multiple strings are supplied as an array ref, a line of POD is
produced for each string.  Each line will be separated by a newline.
This is useful for splitting longer text across multiple lines in a
\&\f(CW\*(C`weaver.ini\*(C'\fR file, for example:
.PP
.Vb 8
\&  ; weaver.ini
\&  [Version]
\&  format = version %v
\&  format =
\&  format = This module\*(Aqs version numbers follow the conventions described at
\&  format = L<semver.org|http://semver.org/>.
\&  format = %T
\&  format = %T This is a trial release!
.Ve
.SS is_verbatim
.IX Subsection "is_verbatim"
A boolean value specifying whether the version paragraph should be verbatim or not.
.PP
Default: false
.SS time_zone
.IX Subsection "time_zone"
The timezone to use when using DateTime for the format.
.PP
Default: local
.SH METHODS
.IX Header "METHODS"
.SS build_content
.IX Subsection "build_content"
.Vb 1
\&  my @pod_elements = $section\->build_content(\e%input);
.Ve
.PP
This method is passed the same \f(CW\*(C`\e%input\*(C'\fR that goes to the \f(CW\*(C`weave_section\*(C'\fR
method, and should return a list of pod elements to insert.
.PP
In almost all cases, this method is used internally, but could be usefully
overridden in a subclass.
.SH AUTHOR
.IX Header "AUTHOR"
Ricardo SIGNES <cpan@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2024 by Ricardo SIGNES.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.