Christopher J. Madsen > Pod-Weaver-Section-Template-0.03 > Pod::Weaver::Section::Template

Download:
Pod-Weaver-Section-Template-0.03.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.03   Source   Latest Release: Pod-Weaver-Section-Template-0.04

NAME ^

Pod::Weaver::Section::Template - add pod section from a Text::Template template

VERSION ^

version 0.03

SYNOPSIS ^

  # weaver.ini
  [Template / SUPPORT]
  template = ~/.dzil/pod_templates/support.section
  main_module_only = 1

DESCRIPTION ^

This plugin generates a pod section based on the contents of a template file. The template is parsed using Text::Template, and is then interpreted as pod. When parsing the template, $filename will be the name of the file being woven (if that was passed to Pod::Weaver), and $plugin will be this plugin. Any options specified in the plugin configuration which aren't configuration options for this plugin will be provided as variables for the template. Also, if this is being run as part of a Dist::Zilla build process, the values of all of the attributes on the zilla object will be available as variables, and the additional variable $main_module_name will be defined as the module name for the main_module file.

ATTRIBUTES ^

template

The file to be run through Text::Template and added as a pod section. Required.

header

The section header. Defaults to the plugin name.

main_module_only

If Pod::Weaver is being run through Dist::Zilla, this option determines whether to add the section to each module in the distribution, or to just the distribution's main module. Defaults to false.

SEE ALSO ^

Text::Template Pod::Weaver Dist::Zilla

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Jesse Luehrs.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: