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

ATTRIBUTES

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

TEMPLATE RENDERING

75       When rendering as a template, the variables $plugin, $dist, and
76       $distmeta will be provided, set to the GenerateSection plugin,
77       "Dist::Zilla" object, and the distribution metadata hash respectively.
78       For convenience, the following variables are also set:
79
80       •   $name
81
82       •   $version
83
84       •   $homepage
85
86       •   $repository_web
87
88       •   $repository_url
89
90       •   $bugtracker_web
91
92       •   $bugtracker_email
93

AUTHOR

95       Ricardo SIGNES <rjbs@cpan.org>
96

98       This software is copyright (c) 2021 by Ricardo SIGNES.
99
100       This is free software; you can redistribute it and/or modify it under
101       the same terms as the Perl 5 programming language system itself.
102
103
104
105perl v5.32.1                      2021-P0o4d-:1:9Weaver::Section::GenerateSection(3)
Impressum