[%# # 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 = 'Stash_XS' %] [% WRAPPER toc; PROCESS tocitem title ="SYNOPSIS" subs = []; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="BUGS" subs = []; PROCESS tocitem title ="AUTHORS" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; PROCESS tocitem title ="SEE ALSO" subs = []; END %] [% WRAPPER section title="SYNOPSIS" -%]
    use Template;
    use Template::Stash::XS;
    my $stash = Template::Stash::XS->new(\%vars);
    my $tt2   = Template->new({ STASH => $stash });
[%- END %] [% WRAPPER section title="DESCRIPTION" -%]

The Template:Stash::XS module is an implementation of the Template::Stash written in C. The "XS" in the name refers to Perl's XS extension system for interfacing Perl to C code. It works just like the regular Perl implementation of Template::Stash but runs about twice as fast.

The easiest way to use the XS stash is to configure the Template Toolkit to use it by default. You can do this at installation time (when you run 'perl Makefile.PL') by answering 'y' to the questions:

    Do you want to build the XS Stash module?      y
    Do you want to use the XS Stash by default?    y

See the INSTALL file distributed with the Template Toolkit for further details on installation.

If you don't elect to use the XS stash by default then you should use the 'STASH' configuration item when you create a new Template object. This should reference an XS stash object that you have created manually.

    use Template;
    use Template::Stash::XS;
    my $stash = Template::Stash::XS->new(\%vars);
    my $tt2   = Template->new({ STASH => $stash });

Alternately, you can set the '$Template::Config::STASH' package variable like so:

    use Template;
    use Template::Config;
    $Template::Config::STASH = 'Template::Stash::XS';
    my $tt2 = Template->new();

The XS stash will then be automatically used.

If you want to use the XS stash by default and don't want to re-install the Template Toolkit, then you can manually modify the 'Template/Config.pm' module near line 42 to read:

    $STASH = 'Template::Stash::XS';
[%- END %] [% WRAPPER section title="BUGS" -%]

Please report bugs to the Template Toolkit mailing list templates@template-toolkit.org

[%- END %] [% WRAPPER section title="AUTHORS" -%]

Andy Wardley <abw@tt2.org>

Doug Steinwand <dsteinwand@citysearch.com>

[%- END %] [% WRAPPER section title="VERSION" -%]

Template Toolkit version 2.19, released on 27 April 2007.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]
  Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.

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

[%- END %] [% WRAPPER section title="SEE ALSO" -%]

[% ttlink('Template::Stash', 'Template::Stash') -%]

[%- END %]