Pod::Weaver::PluginBundle::Author::TABULO - TABULO's bundle for Pod::Weaver (providing a default config for his distros)
[TABULO]: This module started out as a copy of @DAGOLDEN's, including its documentation, copied and re-adapted below.
This is a Pod::Weaver PluginBundle. It is roughly equivalent to the following weaver.ini:
[Generic / FOREWORD]
[Generic / USAGE]
[Generic / OVERVIEW]
[Generic / STABILITY]
[Collect / REQUIREMENTS]
command = requires
[Collect / CONSTRUCTORS]
command = constructor
[ClassMopper / ATTRIBUTES]
no_tagline = 1
skip_methods = 1
skip_attributes = 0
transformer = List
This PluginBundle is used automatically with the @Author::TABULO Dist::Zilla plugin bundle.
It also has region collectors for:
# Some PLUGIN possibilities (found on CPAN) include : # # Pod::Weaver::Section::* # * AllowOverride - Allow POD to override a Pod::Weaver-provided # * Collect::FromOther - Import sections from other POD # * CommentString - Add Pod::Weaver section with content extracted from comment with specified key # * Bugs::DefaultRT - Add a BUGS section to refer to bugtracker (or RT as default) # * GenerateSection - add pod section from an interpolated piece of text # * ReplaceName - Add or replace a NAME section with abstract. # * SeeAlso - add a SEE ALSO pod section. Also supports #SEEALSO comments (preferable). # WARNING: The 'SEE ALSO' section in your POD, if present, # should just be a list of links (one per line), without any POD commands. # * Template - add pod section from a Text::Template template # * WarrantyDisclaimer - Add a standard DISCLAIMER OF WARRANTY section (for your Perl module) # # * Extends - Add a list of parent classes to your POD. # * Consumes - Add a list of roles to your POD. WARNING: This one has some CAVEATS (refer to CPAN). # * Requires - Add Pod::Weaver section with all used modules from package excluding listed ones, e.g. : # [Requires] # ignore = base lib constant namespace::sweep # # Pod::Weaver::Plugin::* # .* AppendPrepend - Merge append:FOO and prepend:FOO sections in POD # .* Include - Support for including sections of Pod from other files # .* EnsureUniqueSections - Ensure that POD has no duplicate section headers. # NOTE: Setting strict=1 will disable smart detection of duplicates (plural forms, collapsed space, ...) # * Exec - include output of commands in your pod # * Run - Write Pod::Weaver::Plugin directly in 'weaver.ini' # WARNING: Seems to be a bit esoteric. # * SortSections - Sort POD sections # .* StopWords - Dynamically add stopwords to your woven pod. XXX: Staying away from this, as it adds lines on top of the module. # .* WikiDoc - allow wikidoc-format regions to be translated during dialect phase
This software is copyright (c) 2023 by Tabulo[n].
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dist::Zilla::PluginBundle::Author::TABULO, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.