Pod::Weaver::PluginBundle::Author::LXP - configure Pod::Weaver like LXP
This module is part of distribution Pod-Weaver-PluginBundle-Author-LXP v1.0.0.
This distribution's version numbering follows the conventions defined at semver.org.
In weaver.ini:
[@Author::LXP]
This Pod::Weaver plugin bundle configures Pod::Weaver the way CPAN author LXP uses it, achieving the same result as these entries in a weaver.ini file:
LXP
;; SETUP ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ; "A bundle for the most commonly-needed prep work for a POD ; document." Not sure what it actually does, but it's probably ; important. [@CorePrep] ; "Stopwords" are words that a spell checker might otherwise flag ; as misspelt. This plugin adds some words based on the ; distribution's content and gathers explicitly defined ones at the ; top so that they are also honoured. [-StopWords] ; Provide a "list" POD formatter for easier definition of lists. [-Transformer] transformer = List ;; POD RENDERING AND ORDERING ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ; Emit a NAME section. [Name] ; Emit a VERSION section. The version number is determined by ; Dist::Zilla. [Version] format = This module is part of distribution %r v%v.%n%nThis dis... ; Emit a SYNOPSIS section if it exists. [Generic / SYNOPSIS] ; Emit a DESCRIPTION section. Enforce its existence for every ; module. [Generic / DESCRIPTION] required = 1 ; Emit any other POD material that isn't handled elsewhere in this ; configuration, including further down. [Leftovers] ; Emit an ATTRIBUTES section for each attribute defined in the ; source. [Collect / ATTRIBUTES] command = attr ; Similar for METHODS. [Collect / METHODS] command = method ; Emit a SEE ALSO section, automatically formatting items as lists. ; Don't emit the default explanatory text above the links. [SeeAlso] header = add_main_link = 0 ; Emit a SUPPORT section in the main module's documentation. [Support] perldoc = 0 websites = none repository_content = The source code for this distribution is repository_content = available online in a repository_content = L<Git|http://git-scm.com/> repository. Please repository_content = feel welcome to contribute patches. repository_content = ; Emit an AUTHOR section. [Authors] ; Emit a COPYRIGHT AND LICENSE section. Refer the reader to a copy ; of the full license contained within the distribution. [Legal] license_file = LICENSE
In the absence of any real documentation on how to write a Pod::Weaver plugin bundle, the presence of such bundles previously written by RJBS and DOHERTY was greatly appreciated:
RJBS
DOHERTY
Pod::Weaver::PluginBundle::RJBS
Pod::Weaver::PluginBundle::Author::DOHERTY
See Config::MVP::Assembler::WithBundles.
Please report any bugs or feature requests by email to bug-pod-weaver-pluginbundle-author-lxp at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Weaver-PluginBundle-Author-LXP. You will be automatically notified of any progress on the request by the system.
bug-pod-weaver-pluginbundle-author-lxp at rt.cpan.org
The source code for this distribution is available online in a Git repository. Please feel welcome to contribute patches.
https://github.com/lx/perl5-Pod-Weaver-PluginBundle-Author-LXP
git clone git://github.com/lx/perl5-Pod-Weaver-PluginBundle-Author-LXP
Alex Peters <lxp@cpan.org>
This software is copyright (c) 2013 by Alex Peters.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
The full text of the license can be found in the 'LICENSE' file included with this distribution.
To install Pod::Weaver::PluginBundle::Author::LXP, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Weaver::PluginBundle::Author::LXP
CPAN shell
perl -MCPAN -e shell install Pod::Weaver::PluginBundle::Author::LXP
For more information on module installation, please visit the detailed CPAN module installation guide.