Module::Template::Setup - aid in setting up a module based on templates
Module::Template::Setup 0.03
my $module = Module::Template::Setup->new($modulename);
$module->setup();
The goal of Module::Template::Setup is to provide a simple tool for speeding up the proces of spawning new modules by taking away all the boring work of adding all the required files and populating them with all the redundant information.
The module aims to combine the following parameters:
Module::Template::Setup is currently in alpha and requires a lot of work (please see the TODO below).
This is the constructor. It takes one argument a string holding the modulename in either of the following formats:
This method does the actual work, based on the initialized object.
setup takes an optional argument 'build' which can be set to either:
setup also takes can also fill in license details for the following license types:
It is possilbe to give an license name, which is unknown by the module, or you can overwrite the license description my giving the argument "licensedetails".
See Module::Template::Setup::Licenses for more details on licenses - more licenses or better descriptions are of course welcome.
The proces in setup.
Reserverd words are a list of names, which are not suitable as template placeholders.
more will follow...
The following directories are always built:
The following templates are used to populate the directories.
In the root directory:
placed in the appropriate sub directory based on module name (SEE: setup).
If you are not satisfied with the population of the templates, you can edit the templates to suit your needs.
Example: if you prefer the Perl modulenaming convention with '::' instead of the filesystem convention with -, you can just exchange $MODULENAME with $MODULENAME_PERL.
These are some of the defined defaults values for the PLACEHOLDERS used in the TEMPLATES.
Apart from the values mentioned in DEFAULTS (above) this is a list of the current placeholders, which can be set.
Should be set in you configuration file
Should be set in you configuration file
This is comes from the argument given to the constructor
This is auto-resolved from the MODULENAME
This is auto-resolved from the MODULENAME
This is auto-resolved from the MODULENAME
Should be set in your configuration file
Should be set in your configuration file
When running the script, CGI::FastTemplate issues a warning, due to the fact that some of the templates contain a scalar called: $VERSION.
Since CGI::FastTemplate does (should) not know any variables of this name and it follows the naming convention for $placeholders to be used, it issues the following warning-
Please refer to the list of RESERVED WORDS for more of these.
The template naming is also somewhat crazy, apparently templates names cannot contain - (dash) or start with numbers, then they have to be quoted.
There are no known bugs at the time of writing, if you experience any bugs, please report them using the following email address:
<bug-module-template-setup@rt.cpan.org>
Feedback also welcome on this address or directly to me on the address below (SEE: AUTHOR).
Jonas B. Nielsen (jonasbn) - <jonasbn@cpan.org>
Module::Template::Setup is (C) by Jonas B. Nielsen (jonasbn) 2004
Module::Template::Setup and related script and modules are free software and is released under the Artistic License. See http://www.perl.com/language/misc/Artistic.html for details.
