Randy Stauner > Dist-Zilla-Stash-PodWeaver-1.004 > Dist::Zilla::Stash::PodWeaver

Download:
Dist-Zilla-Stash-PodWeaver-1.004.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.004   Source   Latest Release: Dist-Zilla-Stash-PodWeaver-1.005

NAME ^

Dist::Zilla::Stash::PodWeaver - A stash of config options for Pod::Weaver

VERSION ^

version 1.004

SYNOPSIS ^

  # dist.ini

  [@YourFavoritePluginBundle]

  [%PodWeaver]
  -StopWords.include = WordsIUse ThatAreNotWords

DESCRIPTION ^

This performs the Dist::Zilla::Role::Stash role (using Dist::Zilla::Role::DynamicConfig and Dist::Zilla::Role::Stash::Plugins).

When using Dist::Zilla::Plugin::PodWeaver with a config_plugin it's difficult to pass more configuration options to Pod::Weaver plugins.

This is often the case when using a Dist::Zilla::PluginBundle that uses a Pod::Weaver::PluginBundle.

This stash is intended to allow you to set other options in your dist.ini that can be accessed by Pod::Weaver plugins.

Because you know how you like your dists built, (and you're using PluginBundles to do it) but you need a little extra customization.

USAGE ^

The attributes should be separated from the plugin name with a dot: PluginName.attributes. The PluginName will be passed to Pod::Weaver::Config::Assembler->expand_package() so the PluginName should include the leading character to identify its type:

For example

  Complaints.use_fake_email = 1

Would set the 'use_fake_email' attribute to '1' for the [fictional] Pod::Weaver::Section::Complaints plugin.

  -StopWords.include = Flibberoloo

Would add 'Flibberoloo' to the list of stopwords added by the Pod::Weaver::Plugin::StopWords plugin.

  +Some::Other::Module.silly = 1

Would set the 'silly' flag to true on Some::Other::Module.

METHODS ^

expand_package

Expand shortened package monikers to the full package name.

Changes leading + to = and then passes the value to expand_package in Pod::Weaver::Config::Assembler.

See "USAGE" for a description.

BUGS AND LIMITATIONS ^

SUPPORT ^

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc Dist::Zilla::Stash::PodWeaver

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-dist-zilla-stash-podweaver at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dist-Zilla-Stash-PodWeaver. You will be automatically notified of any progress on the request by the system.

Source Code

https://github.com/rwstauner/Dist-Zilla-Stash-PodWeaver

  git clone https://github.com/rwstauner/Dist-Zilla-Stash-PodWeaver.git

AUTHOR ^

Randy Stauner <rwstauner@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2010 by Randy Stauner.

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: