--- name: "Module::Starter::Plugin::CGIApp" section: "3pm" platform: "linux" package: "libmodule-starter-plugin-cgiapp-perl" version: "0.44-1.1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/Module::Starter::Plugin::CGIApp" --- # Module::Starter::Plugin::CGIApp(3pm) template based module starter for CGI apps. ## NAME Module::Starter::Plugin::CGIApp - template based module starter for CGI apps. ## SYNOPSIS ``` use Module::Starter qw( Module::Starter::Plugin::CGIApp ); Module::Starter->create_distro(%args); ``` ## ABSTRACT This is a plugin for Module::Starter that builds you a skeleton CGI::Application module with all the extra files needed to package it for CPAN. You can customize the output using HTML::Template. ## VERSION This document describes version 0.44 ## DESCRIPTION This module subclasses Module::Starter::Simple and includes functionality similar to Module::Starter::Plugin::Template. This document only describes the methods which are overridden from those modules or are new. Only developers looking to extend this module need to read this. If you just want to use Module::Starter::Plugin::CGIApp, read the docs for cgiapp-starter or titanium-starter instead. ## METHODS ### new ( %args ) This method calls the `"new"` supermethod from Module::Starter::Plugin::Simple and then initializes the template store. (See `"templates"`.) ### create\_distro ( %args ) This method works as advertised in Module::Starter. ### create\_LICENSE( ) This method creates a `"LICENSE"` file in the distribution's directory which can hold the distribution's license terms. ### create\_MANIFEST\_SKIP( ) This method creates a `"MANIFEST.SKIP"` file in the distribution's directory so that unneeded files can be skipped from inclusion in the distribution. ### create\_modules( @modules ) This method will create a starter module file for each module named in *@modules*. It is only subclassed from Module::Starter::Simple here so we can change the *rtname* tmpl\_var to be the distro name instead of the module name. ### create\_perlcriticrc( ) This method creates a `"perlcriticrc"` in the distribution's author test directory so that the behavior of `"perl-critic.t"` can be modified. ### create\_server\_pl( ) This method creates `"server.pl"` in the distribution's root directory. ### create\_t( @modules ) This method creates a bunch of \*.t files. *@modules* is a list of all modules in the distribution. ### create\_tmpl( ) This method takes all the template files ending in .html (representing HTML::Template's and installs them into a directory under the distro tree. For instance if the distro was called `"Foo-Bar"`, the templates would be installed in `"lib/Foo/Bar/templates"`. Note the files will just be copied over not rendered. ### create\_xt( @modules ) This method creates a bunch of \*.t files for author tests. *@modules* is a list of all modules in the distribution. ### render( $template, \\%options ) This method is given an HTML::Template and options and returns the resulting document. Data in the `"Module::Starter"` object which represents a reference to an array `@foo` is transformed into an array of hashes with one key called `$foo_item` in order to make it usable in an HTML::Template `"TMPL_LOOP"`. For example: ``` $data = ['a'. 'b', 'c']; ``` would become: ``` $data = [ { data_item => 'a' }, { data_item => 'b' }, { data_item => 'c' }, ]; ``` so that in the template you could say: ``` ``` ### templates ( ) This method reads in the template files and populates the object's templates attribute. The module template directory is found by checking the `"MODULE_TEMPLATE_DIR"` environment variable and then the config option `"template_dir"`. ### Build\_PL\_guts($main\_module, $main\_pm\_file) This method is called by create\_Build\_PL and returns text used to populate Build.PL when the builder is Module::Build; *$main\_pm\_file* is the filename of the distribution's main module, *$main\_module*. ### Changes\_guts Implements the creation of a `"Changes"` file. ### LICENSE\_guts Implements the creation of a `"LICENSE"` file. ### Makefile\_PL\_guts($main\_module, $main\_pm\_file) This method is called by create\_Makefile\_PL and returns text used to populate Makefile.PL when the builder is ExtUtils::MakeMaker; *$main\_pm\_file* is the filename of the distribution's main module, *$main\_module*. ### MANIFEST\_SKIP\_guts Implements the creation of a `"MANIFEST.SKIP"` file. ### MI\_Makefile\_PL\_guts($main\_module, $main\_pm\_file) This method is called by create\_MI\_Makefile\_PL and returns text used to populate Makefile.PL when the builder is Module::Install; *$main\_pm\_file* is the filename of the distribution's main module, *$main\_module*. ### module\_guts($module, $rtname) Implements the creation of a `"README"` file. ### README\_guts($build\_instructions) Implements the creation of a `"README"` file. ### perlcriticrc\_guts Implements the creation of a `"perlcriticrc"` file. ### server\_pl\_guts Implements the creation of a `"server.pl"` file. ### t\_guts(@modules) Implements the creation of test files. *@modules* is a list of all the modules in the distribution. ### tmpl\_guts Implements the creation of template files. ### xt\_guts(@modules) Implements the creation of test files for author tests. *@modules* is a list of all the modules in the distribution. ## BUGS Please report any bugs or feature requests to `"bug-module-starter-plugin-cgiapp at rt.cpan.org"`, or through the web interface at rt.cpan.org \. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. ## AUTHOR Jaldhar H. Vyas, \ ## COPYRIGHT Copyright (C) 2015, Consolidated Braincells Inc. All Rights Reserved. This distribution is free software; you can redistribute it and/or modify it under the terms of either: a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the Artistic License version 1.0 or a later version. The full text of the license can be found in the LICENSE file included with this distribution. ## SEE ALSO cgiapp-starter, titanium-starter, Module::Starter, Module::Starter::Simple, Module::Starter::Plugin::Template. CGI::Application, Titanium, HTML::Template