.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Pod::Weaver::Section::Version 3pm"
.TH Pod::Weaver::Section::Version 3pm "2016-10-22" "perl v5.24.1" "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.015
.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 "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "header"
.IX Subsection "header"
The title of the header to be added.
(default: \*(L"\s-1VERSION\*(R"\s0)
.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 \*(L"\-TRIAL\*(R" if a trial release
.IP "\(bu" 4
d \- the \s-1CLDR\s0 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 \s-1POD\s0!
.IP "\(bu" 4
m \- the name of the module, present only if \s-1PPI\s0 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 \s-1POD\s0 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 \s-1SIGNES\s0 <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Ricardo \s-1SIGNES.\s0
.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.