Pod::W...Version(3pm)

💅 Pod::W...Version(3pm) 💅

okay so bestie, first things first: this page lives in the User Contributed Perl Documentation manual, and the module is Pod::Weaver::Section::Version. say it with me now 🫶

✨ NAME ✨

Pod::Weaver::Section::Version — it adds a VERSION pod section. that's the whole gig. iconic behavior honestly.

🎀 VERSION 🎀

version 4.020 — yes, the version section plugin has its own version. very meta of her. main character energy fr fr 💅

🌸 OVERVIEW 🌸

so this little section plugin produces a hunk of Pod meant to indicate the version of the document you're looking at. it's giving:

  =head1 VERSION

  version 1.234

and like, lowkey important: it will do nothing if there's no "version" entry in the input. no version, no vibes. it just sits there quietly. 🤷‍♀️

🦋 PERL VERSION 🦋

the tea ☕: this module should work on any version of perl still receiving updates from the Perl 5 Porters. which means it should work on any version of perl released in the last two to three years. (like, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.) slay.

although it may work on older versions of perl, there is no guarantee 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. periodt. don't come for her. 💀

💖 ATTRIBUTES 💖

⭐ header

the title of the header to be added. (default: "VERSION") — cute, simple, to the point.

⭐ format

the string to use when generating the version string. her little costume change, if you will.

Default: version %v

the following variables are available:

• v — the version
• V — the version, suffixed by "-TRIAL" if a trial release
• d — the CLDR format for DateTime
• n — a newline
• t — a tab
• s — a space
• r — the name of the dist, present only if you use Dist::Zilla to generate the POD!
• m — the name of the module, present only if PPI parsed the document and it contained a package declaration!
• 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 🔥

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!

see how she ate that? 🍓

⭐ is_verbatim

a boolean value specifying whether the version paragraph should be verbatim or not.

Default: false

⭐ time_zone

the timezone to use when using DateTime for the format.

Default: local

---

🌈 METHODS 🌈

💜 build_content

  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. iykyk 🧚

---

👑 AUTHOR 👑

Ricardo SIGNES <cpan@semiotic.systems> — the legend herself. we stan.

💐 COPYRIGHT AND LICENSE 💐

this software is copyright (c) 2024 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. 🫶

---

okay that's the whole page, bestie!! no cap, you're now a Pod::Weaver::Section::Version expert 💅✨

and for the little sign-off moment: this page was rendered by perl v5.38.2 on 2024-03-24, under that Pod::W...Version(3pm) header you saw up top. bye babe!! 🎀🦋💖