NAME¶

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

VERSION¶

version 1.06

SYNOPSIS¶

In your weaver.ini

  [GenerateSection]
  title = HOMEPAGE
  text  = This is the POD for distribution {{$name}}. Check out what we have
  text  = been up to at {{$homepage}}

The title value can be omited if passed as the plugin name:

  [GenerateSection / HOMEPAGE]

DESCRIPTION¶

This plugin attempts to be a cross between Pod::Weaver::Section::Template and Dist::Zilla::Plugin::GenerateFile without the generation of extra files.

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 POD text without need for extra files. For example:

  [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}}

ATTRIBUTES¶

Text as template¶

Unless the option "is_template" is false, the text will be run through Text::Template. The variables $plugin, $dist, and $distmeta will be provided, set to the GenerateSection plugin, "Dist::Zilla" object, and the distribution metadata hash respectively. For convenience, the following variables are also set:

$name

$version

$homepage

$repository_web

$repository_url

$bugtracker_web

$bugtracker_email

AUTHOR¶

Carnë Draug <cdraug@cpan.org>

COPYRIGHT AND LICENSE¶

This software is Copyright (c) 2013-2017 by Carnë Draug.

This is free software, licensed under:

  The GNU General Public License, Version 3, June 2007