NAME

Uttu::Handler::template

SYNOPSIS

[global]
  content_handler = template

[template]

DESCRIPTION

By setting the global content_handler configuration variable to template, Template will be called to parse the web pages and create the content. This module depends on Apache::Template to provide the Template service handler.

GLOBALS

The Template content handler makes the following global variables available.

u

This is the Uttu object responsible for the current request.

lh

If internationalization is enabled, then this is defined and is the Locale::Maketext object providing translation services into the preferred language of the client.

r

The Apache::Request object.

CONFIGURATION

These variables are used to configure the Template object. The variable names should be preceeded with template_ or placed in a [template] section.

absolute

A flag indicating whether or not to allow absolute file names.

The default is false.

anycase

Whether or not to allow directives in lower case.

The default is false, requiring directives to be in all UPPER case.

auto_reset

A flag enabling BLOCK definitions to persist across templates. Note that we current construct a new Template object for each request.

The default is false.

block

block NAME = CODE

Pre-define a template block with the name NAME.

cache_size

Maximum number of compiled templates to cache in memory.

The default is undef -- cache all templates.

compile_dir

Root of directory in which compiled template files should be written. This may be a relative path which will be taken as relative to the server root.

The default is undef -- do not compile.

compile_ext

The filename extension for compiled template files.

Default is undef -- do not compile.

debug

A flag indicating whether or not to raise an error when an undefined variable is accessed.

The default is false.

default

The default template to use when another is not found.

delimiter

The delimiter separating paths in INCLUDE_PATH. This does not affect how include_path is used in the Uttu configuration file.

The default is `:'.

end_tag

This is the token that indicates the end of directives.

The default is %].

error

Mapping of error types to templates.

eval_perl

A flag indicating whether or not PERL/RAWPERL blocks should be processed.

The default is false.

filter

Map a filter name to a filter subroutine or factory.

include_path

A list of directories in which to search for templates. If this is not defined, then $server_root/local is added.

If a framework is defined, then the installation directories of the framework and function sets are added.

interpolate

Whether or not to interpolate variables embedded as $this or ${this}.

The default is false.

load_filter

Load the specified filter provider.

load_perl

A flag to indicate whether regular Perl modules should be loaded if a named plugin can't be found.

The default is false.

load_plugin

Load the specifide plugin provider.

load_template

Load the specifide template provider.

plugin

plugin PLUGIN My::Package

Map plugin names to Perl packages.

plugin_base

One or more base classes under which plugins may be found.

post_chomp

A flag indicating whether or not to remove whitespace after directives.

The default is false.

post_process

Name of templates to process after the main template.

pre_chomp

A flag indicating whether or not to remove whitespace before directives.

The default is false.

pre_define

pre_define key = value

A mapping of variables to values to pre-define in the stash.

pre_process

Name of templates to process before the main template.

recursion

A flag indicating whether or not to allow recursion into templates.

The default is false.

relative

A flag indicating whether or not to allow relative filenames.

The default is false.

start_tag

This is the token that indicates the beginning of directives.

The default is [%.

tag_style

Sets start_tag amd end_tag according to a pre-defined style.

The default is `template' giving the default values for start_tag and end_tag.

tolerant

A flag indicating whether or not providers should tolerate errors as declinations.

The default is false.

trim

Whether or not to remove leading and trailing whitespace from template output.

The default is false.

v1dollar

A flag indicating whether or not to enable version 1.* handling of leading `$' on variables.

The default is false -- `$' indicates interpolation.

SEE ALSO

Template.

AUTHOR

James G. Smith <jsmith@cpan.org>

The descriptions of the Template configuration variables are based on the Template documentation.

COPYRIGHT

Copyright (C) 2002 Texas A&M University. All Rights Reserved.

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