.\" -*- 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::Region 3pm"
.TH Pod::Weaver::Section::Region 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::Region \- find a region and put its contents in place where desired
.SH VERSION
.IX Header "VERSION"
version 4.020
.SH OVERVIEW
.IX Header "OVERVIEW"
This section will find and include a located hunk of Pod.  In general, it will
find a region with the specified name, such as:
.PP
.Vb 1
\&  =begin :myfoo
\&
\&  =head1 More Pod Here
\&
\&  =end :myfoo
.Ve
.PP
In other words, if your configuration include:
.PP
.Vb 2
\&  [Region]
\&  region_name = myfoo
.Ve
.PP
\&...then this weaver will look for "=begin :myfoo" ( and "=for :myfoo" and... ) and include
it at the appropriate location in your output.
.PP
Since you'll probably want to use Region several times, and that will require
giving each use a unique name, you can omit \f(CW\*(C`region_name\*(C'\fR if you provide a
plugin name, and it will default to the plugin name.  In other words, the
configuration above could be specified just as:
.PP
.Vb 1
\&  [Region / myfoo]
.Ve
.PP
If the \f(CW\*(C`required\*(C'\fR attribute is given, and true, then an exception will be
raised if this region can't be found.
.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 required
.IX Subsection "required"
A boolean value specifying whether this region is required to be present or not. Defaults
to false.
.PP
If it's enabled and the region can't be found an exception will be raised.
.SS region_name
.IX Subsection "region_name"
The name of this region. Defaults to the plugin name.
.SS allow_nonpod
.IX Subsection "allow_nonpod"
A boolean value specifying whether nonpod regions are allowed or not. Defaults to false.
.PP
\&\f(CW\*(C`nonpod\*(C'\fR regions are regions \fIwithout\fR a \f(CW\*(C`:\*(C'\fR prefix as explained in
perlpodspec
.PP
.Vb 3
\&  # region_name = myregion
\&  # is_pod = false
\&  =begin myregion
\&
\&  # region_name = myregion
\&  # is_pod = true
\&  =begin :myregion
.Ve
.SS flatten
.IX Subsection "flatten"
A boolean value specifying whether the region's contents should be flattened or not. Defaults to true.
.PP
.Vb 2
\&  #unflattened
\&  =begin :myregion
\&
\&  =head1
\&
\&  =end :myregion
\&
\&  #flattened
\&  =head1
.Ve
.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.