Pod::Weaver::Section::Version(3pm) | User Contributed Perl Documentation | Pod::Weaver::Section::Version(3pm) |
Pod::Weaver::Section::Version - add a VERSION pod section
version 4.015
This section plugin will produce a hunk of Pod meant to indicate the version of the document being viewed, like this:
=head1 VERSION version 1.234
It will do nothing if there is no "version" entry in the input.
The title of the header to be added. (default: "VERSION")
The string to use when generating the version string.
Default: version %v
The following variables are available:
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 "weaver.ini" file, for example:
; weaver.ini [Version] format = version %v format = format = This module's version numbers follow the conventions described at format = L<semver.org|http://semver.org/>. format = %T format = %T This is a trial release!
A boolean value specifying whether the version paragraph should be verbatim or not.
Default: false
The timezone to use when using DateTime for the format.
Default: local
my @pod_elements = $section->build_content(\%input);
This method is passed the same "\%input" that goes to the "weave_section" method, and should return a list of pod elements to insert.
In almost all cases, this method is used internally, but could be usefully overridden in a subclass.
Ricardo SIGNES <rjbs@cpan.org>
This software is copyright (c) 2016 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
2016-10-22 | perl v5.24.1 |