[%#
# IMPORTANT NOTE
# This documentation is generated automatically from source
# templates. Any changes you make here may be lost.
#
# The 'docsrc' documentation source bundle is available for download
# from http://www.template-toolkit.org/docs.html and contains all
# the source templates, XML files, scripts, etc., from which the
# documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
page = 'Namespace_Constants'
%]
[% WRAPPER toc;
PROCESS tocitem
title ="SYNOPSIS"
subs = [];
PROCESS tocitem
title ="DESCRIPTION"
subs = [];
PROCESS tocitem
title ="PUBLIC METHODS"
subs = [
"new(\\%constants)",
"ident(\\@ident)"
];
PROCESS tocitem
title ="AUTHOR"
subs = [];
PROCESS tocitem
title ="VERSION"
subs = [];
PROCESS tocitem
title ="COPYRIGHT"
subs = [];
PROCESS tocitem
title ="SEE ALSO"
subs = [];
END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
title="SYNOPSIS"
-%]<pre> # easy way to define constants
use Template;</pre>
<pre> my $tt = Template->new({
CONSTANTS => {
pi => 3.14,
e => 2.718,
},
});</pre>
<pre> # nitty-gritty, hands-dirty way
use Template::Namespace::Constants;</pre>
<pre> my $tt = Template->new({
NAMESPACE => {
constants => Template::Namespace::Constants->new({
pi => 3.14,
e => 2.718,
},
},
});</pre>
[%- END %]
[% WRAPPER section
title="DESCRIPTION"
-%]<p>
The Template::Namespace::Constants module implements a namespace handler
which is plugged into the Template::Directive compiler module. This then
performs compile time constant folding of variables in a particular namespace.
</p>
[%- END %]
[% WRAPPER section
title="PUBLIC METHODS"
-%][% WRAPPER subsection
title = "new(\\%constants)"
-%]<p>
The new() constructor method creates and returns a reference to a new
Template::Namespace::Constants object. This creates an internal stash
to store the constant variable definitions passed as arguments.
</p>
<pre> my $handler = Template::Namespace::Constants->new({
pi => 3.14,
e => 2.718,
});</pre>
[%- END %]
[% WRAPPER subsection
title = "ident(\\@ident)"
-%]<p>
Method called to resolve a variable identifier into a compiled form. In this
case, the method fetches the corresponding constant value from its internal
stash and returns it.
</p>
[%- END %]
[%- END %]
[% WRAPPER section
title="AUTHOR"
-%]<p>
Andy Wardley <abw@andywardley.com>
</p>
<p>
[% ttlink('http://www.andywardley.com/', 'http://www.andywardley.com/') -%]
</p>
[%- END %]
[% WRAPPER section
title="VERSION"
-%]<p>
1.23, distributed as part of the
Template Toolkit version 2.14, released on 04 October 2004.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
-%]<pre> Copyright (C) 1996-2004 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
title="SEE ALSO"
-%]<p>
[% ttlink('Template::Directive', 'Template::Directive') -%]
</p>
[%- END %]