1Pod::Weaver::Section::GUesneerraCtoenStercitbiuotne(d3P)Poedr:l:WDeoacvuemre:n:tSaetcitoinon::GenerateSection(3)
2
3
4

NAME

6       Pod::Weaver::Section::GenerateSection - add pod section from an
7       interpolated piece of text
8

VERSION

10       version 4.018
11

SYNOPSIS

13       In your weaver.ini
14
15         [GenerateSection]
16         title = HOMEPAGE
17         text  = This is the POD for distribution {{$name}}. Check out what we have
18         text  = been up to at {{$homepage}}
19
20       The title value can be omited if passed as the plugin name:
21
22         [GenerateSection / HOMEPAGE]
23

DESCRIPTION

25       This plugin allows the creation of simple text sections, with or
26       without the use of Text::Template for templated text.
27
28       The "text" parameters become the lines of the template.
29
30       The values of text are concatenated and variable names with matching
31       values on the distribution are interpolated.  Specifying the heading
32       level allows one to write down a rather long section of POD text
33       without need for extra files. For example:
34
35         [GenerateSection / FEEDBACK]
36         head = 1
37         [GenerateSection / Reporting bugs]
38         head = 2
39         text = Please report bugs when you find them. While we do have a mailing
40         text = list, please use the bug tracker at {{$bugtracker_web}}
41         text = to report bugs
42         [GenerateSection / Homegape]
43         head = 2
44         text = Also, come check out our other projects at
45         text = {{$homepage}}
46

PERL VERSION SUPPORT

48       This module has the same support period as perl itself:  it supports
49       the two most recent versions of perl.  (That is, if the most recently
50       released version is v5.40, then this module should work on both v5.40
51       and v5.38.)
52
53       Although it may work on older versions of perl, no guarantee is made
54       that the minimum required version will not be increased.  The version
55       may be increased for any reason, and there is no promise that patches
56       will be accepted to lower the minimum required perl.
57

ATTRIBUTES

59   text
60       The text to be added to the section. Multiple values are allowed and
61       will be concatenated. Certain sequences on the text will be replaced
62       (see below).
63
64   head
65       This is the X to use in the "=headX" that's created.  If it's 0 then no
66       heading is added.  It defaults to 1.
67
68   title
69       The title for this section.  If none is given, the plugin's name is
70       used.
71
72   main_module_only
73       If true, this attribute indicates that only the main module's Pod
74       should be altered.  By default, it is false.
75
76
77       If true, the text is treated as a Text::Template template and rendered.
78       This attribute is true by default.
79
80   delim
81       If given, this must be an arrayref with two elements.  These will be
82       the opening and closing delimiters of template variable sections.  By
83       default they are "{{" and "}}".
84

TEMPLATE RENDERING

86       When rendering as a template, the variables $plugin, $dist, and
87       $distmeta will be provided, set to the GenerateSection plugin,
88       "Dist::Zilla" object, and the distribution metadata hash respectively.
89       For convenience, the following variables are also set:
90
91       •   $name
92
93       •   $version
94
95       •   $homepage
96
97       •   $repository_web
98
99       •   $repository_url
100
101       •   $bugtracker_web
102
103       •   $bugtracker_email
104

AUTHOR

106       Ricardo SIGNES <rjbs@semiotic.systems>
107

109       This software is copyright (c) 2021 by Ricardo SIGNES.
110
111       This is free software; you can redistribute it and/or modify it under
112       the same terms as the Perl 5 programming language system itself.
113
114
115
116perl v5.34.0                      2021-P0o7d-:2:2Weaver::Section::GenerateSection(3)
Impressum