Hayo Baan

NAME

Pod::Weaver::PluginBundle::Author::HAYOBAAN - HAYOBAAN's Pod::Weaver configuration

VERSION

version 0.013

DESCRIPTION

This is a Pod::Weaver PluginBundle, set up according to HAYOBAAN's preferences.

It's main features are:

  • Specific sequence of headings

  • Region collectors for:

    • requires (Requirements)

    • var (Variables)

    • func (Functions)

    • c_attr (Class Attributes)

    • attr (Attributes)

    • construct (Constructors)

    • c_method (Class Methods)

    • method (Methods)

  • Replacing the original pod statements with comments, allowing line numbers to stay the same between development and build versions.

It is roughly equivalent to the following weaver.ini:

  [@CorePrep]

  [-SingleEncoding]
  [-Transformer]
  transformer = List

  [Name]
  [Version]

  [Region / prelude]

  [Generic / SYNOPSIS]
  [Generic / DESCRIPTION]
  [Generic / OVERVIEW]
  [Generic / USAGE]
  [Generic / OPTIONS]

  [Collect / REQUIREMENTS]
  command = requires

  [Collect / VARIABLES]
  command = var

  [Collect / FUNCTIONS]
  command = func

  [Collect / CLASS ATTRIBUTES]
  command = c_attr

  [Collect / ATTRIBUTES]
  command = attr

  [Collect / CONSTRUCTORS]
  command = construct

  [Collect / CLASS METHODS]
  command = c_method

  [Collect / METHODS]
  command = method

  [Leftovers]

  [Region /postlude]

  [Bugs]
  [Generic / STABILITY]
  [Generic / COMPATIBILITY]
  [Generic / SEE ALSO]
  [Generic / CREDITS]
  [Authors]
  [Legal]

USAGE

Add the following line to your weaver.ini:

  [@Author::HAYOBAAN]

or, these lines to your dist.ini file:

  [PodWeaver]
  config_plugin = @Author::HAYOBAAN

Alternatively you can also add the following line to your dist.ini (this will also enable HAYOBAAN's Dist::Zilla setup):

  [@Author::HAYOBAAN]

BUGS

Please report any bugs or feature requests on the bugtracker website.

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

AUTHOR

Hayo Baan <info@hayobaan.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Hayo Baan.

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