Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Module::Starter::PlugiUserTContributed Perl DocModule::Starter::Plugin::TT2(3)

NAME
       Module::Starter::Plugin::TT2 - TT2 templates for
       Module::Starter::Template

VERSION
       version 0.125

SYNOPSIS
	use Module::Starter qw(
	  Module::Starter::Simple
	  Module::Starter::Plugin::Template
	  Module::Starter::Plugin::TT2
	    ...
	);

	Module::Starter->create_distro(	... );

DESCRIPTION
       This Module::Starter plugin is intended to be loaded after
       Module::Starter::Plugin::Template.  It implements the "renderer"	and
       "render"	methods, required by the Template plugin.  The methods are
       implemented with	Template Toolkit.

       This module's distribution includes a directory,	"templates/dir", and a
       file "templates/inline" that contain stock templates for	use with the
       InlineStore and DirStore	plugins.  The module itself contains default
       templates in its	data section.

USAGE
       This module is meant to be used with the	template stores	in the
       SimpleStore distribution	(although you could certainly write your own
       template	store).	 If you	only want to use the built-in templates, you
       could have lines	like this in your config file
       ("~/.module-starter/config"):

	author:	Lord Poncemby
	email: ponce@peerage.eng
	plugins: Module::Starter::Simple Module::Starter::Plugin::Template
	 Module::Starter::Plugin::ModuleStore Module::Starter::Plugin::TT2
	template_module: Module::Starter::Plugin::TT2

       (Where the plugins line is one line.)  This tells Module::Starter to
       look for	the templates in the data section of
       Module::Starter::Plugin::TT2, which isn't very interesting, since
       you'll end up getting the same effect as	if you'd just used
       Module::Starter without plugins.

       To override this	behavior, you'd	instruct Module::Starter to look
       somewhere else, either by changing the "template_module"	setting,
       changing	the MODULE_TEMPLATE_MODULE environment variable, or using a
       different template store	altogether (q.v., SimpleStore or other
       plugins).

METHODS
   "renderer"
       As implemented, this method just	creates	a new Template Toolkit engine
       and stores it in	the Module::Starter object.

   "render( $template, \%options )"
       This method passes the given template contents and options to the TT2
       renderer	and returns the	resulting document.

AUTHOR
       Ricardo SIGNES, "<rjbs@cpan.org>"

COPYRIGHT
       Copyright 2004-2006 Ricardo SIGNES, All Rights Reserved.

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

NAME
       [%module%] - The	fantastic new [%module%]!

VERSION
       version 0.001

SYNOPSIS
       Quick summary of	what the module	does.

       Perhaps a little	code snippet.

	   use [%module%];

	   my $foo = [%module%]->new;
	   ...

EXPORT
       A list of functions that	can be exported.  You can delete this section
       if you don't export anything, such as for a purely object-oriented
       module.

FUNCTIONS
   function1
   function2
AUTHOR
       [%self.author%],	"<[%self.email%]>"

BUGS
       Please report any bugs or feature requests to
       "bug-[%rtname%]@rt.cpan.org", or	through	the web	interface at
       <http://rt.cpan.org>.  I	will be	notified, and then you'll
       automatically be	notified of progress on	your bug as I make changes.

COPYRIGHT & LICENSE
       Copyright [%year%] [%self.author%], All Rights Reserved.

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

perl v5.32.1			  2008-09-15   Module::Starter::Plugin::TT2(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | USAGE | METHODS | AUTHOR | COPYRIGHT | NAME | VERSION | SYNOPSIS | EXPORT | FUNCTIONS | AUTHOR | BUGS | COPYRIGHT & LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Module::Starter::Plugin::TT2&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help