.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.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 "2021-01-08" "perl v5.32.0" "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 1.06
.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 attempts to be a cross between Pod::Weaver::Section::Template and
Dist::Zilla::Plugin::GenerateFile without the generation of extra files.
.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 \s-1POD\s0 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 "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"
The heading level of this section. If 0, there will be no heading. Defaults to 1.
.SS "title"
.IX Subsection "title"
The title for this section. It can optionally be omitted and passed as the
plugin name.
.SS "main_module_only"
.IX Subsection "main_module_only"
If true, it will add the text only to the main module \s-1POD.\s0 Defaults to false.
.SS "is_template"
.IX Subsection "is_template"
If false, it will not attempt to replace the {{}} entries on text. Defaults to
true.
.SH "Text as template"
.IX Header "Text as template"
Unless the option \f(CW\*(C`is_template\*(C'\fR is false, the text will be run through
Text::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:
.ie n .IP "$name" 4
.el .IP "\f(CW$name\fR" 4
.IX Item "$name"
.PD 0
.ie n .IP "$version" 4
.el .IP "\f(CW$version\fR" 4
.IX Item "$version"
.ie n .IP "$homepage" 4
.el .IP "\f(CW$homepage\fR" 4
.IX Item "$homepage"
.ie n .IP "$repository_web" 4
.el .IP "\f(CW$repository_web\fR" 4
.IX Item "$repository_web"
.ie n .IP "$repository_url" 4
.el .IP "\f(CW$repository_url\fR" 4
.IX Item "$repository_url"
.ie n .IP "$bugtracker_web" 4
.el .IP "\f(CW$bugtracker_web\fR" 4
.IX Item "$bugtracker_web"
.ie n .IP "$bugtracker_email" 4
.el .IP "\f(CW$bugtracker_email\fR" 4
.IX Item "$bugtracker_email"
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Carnë Draug <cdraug@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2013\-2017 by Carnë Draug.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve