1Module::Starter::PluginU(s3e)r Contributed Perl DocumentaMtoidounle::Starter::Plugin(3)
2
3
4

NAME

6       Module::Starter::Plugin -- how Module::Starter plugins work
7

DESCRIPTION

9       This document is a guide to writing plugins for Module::Starter.
10       Currently, as is evident, it isn't very comprehensive.  It should
11       provide enough information for writing effective plugins, though.
12       After all, Module::Starter's guts are nice and simple.
13
14   "Module::Starter->import"
15       Module::Starter provides an import method, the arguments to which are
16       plugins, in the order in which they should be loaded.  If no plugins
17       are given, Module::Starter::Simple (and only Module::Starter::Simple)
18       is loaded.
19
20       By default, the given modules are required and arranged in an is-a
21       chain.  That is, Module::Starter subclasses the last plugin given,
22       which subclasses the second-to-last, up to the first plugin given,
23       which is the base class.  If a plugin provides a "load_plugins" method,
24       however, the remaining plugins to be loaded are passed to that method,
25       which is responsible for loading the rest of the plugins.
26
27       This architecture suggests two kinds of plugins:
28
29   engine plugins
30       An engine is a plugin that stands alone, implementing the public
31       "create_distro" method and all the functionality required to carry out
32       that implementation.  The only engine included with Module::Starter is
33       Module::Starter::Simple, and I'm not sure any more will be seen in the
34       wild any time soon.
35
36   plain old plugins
37       Other plugins are designed to subclass an engine and alter its
38       behavior, just as a normal subclass alters its parent class's.  These
39       plugins may add features to Module::Starter engines, or may just
40       provide general APIs for other plugins to exploit (like
41       Module::Starter::Plugin::Template.)
42
43       The template plugin is a simple example of a plugin that alters an
44       engine to accept further plugins.  Other plugins like template will
45       probably be written in the near future, and plugins that exploit the
46       API provided by Module::Starter::Plugin::Template will be available on
47       the CPAN.
48

AUTHOR

50       Ricardo SIGNES "<rjbs at cpan.org>"
51

53       Copyright 2005, Ricardo SIGNES.  All Rights Reserved.
54
55       This program is free software; you can redistribute it and/or modify it
56       under the same terms as Perl itself.
57
58
59
60perl v5.30.1                      2020-01-30        Module::Starter::Plugin(3)
Impressum