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

48       This module should work on any version of perl still receiving updates
49       from the Perl 5 Porters.  This means it should work on any version of
50       perl released in the last two to three years.  (That is, if the most
51       recently released version is v5.40, then this module should work on
52       both v5.40 and v5.38.)
53
54       Although it may work on older versions of perl, no guarantee is made
55       that the minimum required version will not be increased.  The version
56       may be increased for any reason, and there is no promise that patches
57       will be accepted to lower the minimum required perl.
58

ATTRIBUTES

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

TEMPLATE RENDERING

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

AUTHOR

107       Ricardo SIGNES <cpan@semiotic.systems>
108

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