.\" -*- 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::GenerateSection 3pm"
.TH Pod::Weaver::Section::GenerateSection 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::GenerateSection \- add pod section from an interpolated piece of text
.SH VERSION
.IX Header "VERSION"
version 4.020
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In your \fIweaver.ini\fR
.PP
.Vb 4
\&  [GenerateSection]
\&  title = HOMEPAGE
\&  text  = This is the POD for distribution {{$name}}. Check out what we have
\&  text  = been up to at {{$homepage}}
.Ve
.PP
The title value can be omited if passed as the plugin name:
.PP
.Vb 1
\&  [GenerateSection / HOMEPAGE]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This plugin allows the creation of simple text sections, with or without the
use of Text::Template for templated text.
.PP
The \f(CW\*(C`text\*(C'\fR parameters become the lines of the template.
.PP
The values of text are concatenated and variable names with matching values on
the distribution are interpolated.  Specifying the heading level allows one to
write down a rather long section of POD text without need for extra files. For
example:
.PP
.Vb 11
\&  [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}}
.Ve
.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 text
.IX Subsection "text"
The text to be added to the section. Multiple values are allowed and will be
concatenated. Certain sequences on the text will be replaced (see below).
.SS head
.IX Subsection "head"
This is the \fIX\fR to use in the \f(CW\*(C`=headX\*(C'\fR that's created.  If it's \f(CW0\fR then no
heading is added.  It defaults to \f(CW1\fR.
.SS title
.IX Subsection "title"
The title for this section.  If none is given, the plugin's name is used.
.SS main_module_only
.IX Subsection "main_module_only"
If true, this attribute indicates that only the main module's Pod should be
altered.  By default, it is false.
.SS ""
.IX Subsection ""
If true, the text is treated as a Text::Template template and rendered.
This attribute \fBis true by default\fR.
.SS delim
.IX Subsection "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 \f(CW\*(C`{{\*(C'\fR and \f(CW\*(C`}}\*(C'\fR.
.SH "TEMPLATE RENDERING"
.IX Header "TEMPLATE RENDERING"
When rendering as a template, the variables \f(CW$plugin\fR, \f(CW$dist\fR, and
\&\f(CW$distmeta\fR will be provided, set to the GenerateSection plugin,
\&\f(CW\*(C`Dist::Zilla\*(C'\fR object, and the distribution metadata hash respectively. For
convenience, the following variables are also set:
.IP \(bu 4
\&\f(CW$name\fR
.IP \(bu 4
\&\f(CW$version\fR
.IP \(bu 4
\&\f(CW$homepage\fR
.IP \(bu 4
\&\f(CW$repository_web\fR
.IP \(bu 4
\&\f(CW$repository_url\fR
.IP \(bu 4
\&\f(CW$bugtracker_web\fR
.IP \(bu 4
\&\f(CW$bugtracker_email\fR
.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.