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

🌸 NAME 🌸

Pod::Weaver::Section::GenerateSection — add pod section from an interpolated piece of text. Also hi bestie, this manual page is Pod::W...Section(3pm), from the User Contributed Perl Documentation. 💖

✨ VERSION ✨

version 4.020 — slay, we're on that version.

🦋 SYNOPSIS 🦋

In your weaver.ini:

[GenerateSection]
title = HOMEPAGE
text  = This is the POD for distribution {{$name}}. Check out what we have
text  = been up to at {{$homepage}}

You can leave out title if you pass it as the plugin name, like this:

[GenerateSection / HOMEPAGE]

💅 DESCRIPTION 💅

Okay so this plugin lets you create simple text sections, with or without using Text::Template for templated text. ✨

The text parameters become the lines of the template.

The values of text are concatenated, and variable names that match values on the distribution get interpolated. Setting the heading level lets you write down a pretty long section of POD text without needing extra files. For example:

[GenerateSection / FEEDBACK]
head = 1
[GenerateSection / Reporting bugs]
head = 2
text = Please report bugs when you find them. While we do have a mailing
text = list, please use the bug tracker at {{$bugtracker_web}}
text = to report bugs
[GenerateSection / Homegape]
head = 2
text = Also, come check out our other projects at
text = {{$homepage}}

(Yes, Homegape is exactly how it's spelled in the example. We're keeping it. 💀)

🐚 PERL VERSION 🐚

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

It may work on older versions of perl, but no guarantee is made that the minimum required version won't be increased. The version may be increased for any reason, and there's no promise that patches will be accepted to lower the minimum required perl.

🎀 ATTRIBUTES 🎀

• text — the text to be added to the section. Multiple values are allowed and will be concatenated. Certain sequences in the text will be replaced (see below).
• head — this is the X to use in the =headX that's created. If it's 0 then no heading is added. It defaults to 1.
• title — the title for this section. If none is given, the plugin's name is used.
• main_module_only — if true, this attribute indicates that only the main module's Pod should be altered. By default, it is false.

And then the page has this next sentence right after it: "If true, the text is treated as a Text::Template template and rendered. This attribute is true by default." (That's literally what it says, bestie. 💀)

• delim — if given, this must be an arrayref with two elements. These will be the opening and closing delimiters of template variable sections. By default they are {{ and }}.

🌈 TEMPLATE RENDERING 🌈

When rendering as a template, the variables $plugin, $dist, and $distmeta will be provided, set to the GenerateSection plugin, Dist::Zilla object, and the distribution metadata hash respectively. For convenience, the following variables are also set:

• $name
• $version
• $homepage
• $repository_web
• $repository_url
• $bugtracker_web
• $bugtracker_email

👑 AUTHOR 👑

Ricardo SIGNES <cpan@semiotic.systems> — iconic.

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

xoxo, your fave manual page 💅 — this one is from perl v5.38.2, dated 2024-03-24, and its page name is Pod::W...Section(3pm). bye bestie 🫶