NAME

VERSION

SYNOPSIS

        use Tenjin;

        $Tenjin::USE_STRICT = 1;        # use strict in the embedded Perl inside
                                        # your templates. Recommended, but not used
                                        # by default.

        $Tenjin::ENCODING = "UTF-8";    # set the encoding of your template files
                                        # to UTF-8. This is the default encoding used
                                        # so there's no need to do this if your
                                        # templates really are UTF-8.

        my $engine = Tenjin->new(\%options);
        my $context = { title => 'Tenjin Example', items => [qw/AAA BBB CCC/] };
        my $filename = 'file.html';
        my $output = $engine->render($filename, $context);
        print $output;

DESCRIPTION

The Perl version of Tenjin supports embedded Perl code, nestable layout template, inclusion of other templates inside a template, capturing parts of or the entire template output, file and memory caching, template arguments and preprocessing.

The original version of Tenjin is developed by Makoto Kuwata. This CPAN version is developed by Ido Perlmuter and differs from the original in a few key aspects:

• Code is entirely revised, packages are separated into modules, with a smaller number of packages than the original version. In particular, the Tenjin::Engine module no longer exists, and is now instead just the Tenjin module (i.e. this one).
• Support for rendering templates from non-file sources (such as a database) is added.
• Ability to set the encoding of your templates is added (Tenjin will decode template files according to this encoding; by default, Tenjin will decode
• HTML is encoded and decoded using the HTML::Entities module, instead of internally.
• The "pltenjin" script is not provided, at least for now.

To make it clear, the CPAN version of Tenjin might find itself diverting a bit in the future from the original Tenjin's roadmap. Although my aim is to be as compatible as possible (and this version is always updated with features and changes from the original), I cannot guarantee it (but I'll do my best). Please note that version 0.05 (and above) of this module is NOT backwards compatible with previous versions.

METHODS

        # create a Tenjin instance
        my $tenjin = Tenjin->new(\%options);
        
        # create an empty template object
        my $template = Tenjin::Template->new();
        
        # compile template content into Perl code
        $template->convert($tmpl_content);
        $template->compile();

        # register the template with the Tenjin instance
        $tenjin->register_template($tmpl_name, $template);

INTERNAL METHODS

SEE ALSO

Note that the Perl version of Tenjin is refered to as plTenjin on the Tenjin website, and that, as opposed to this module, the website suggests using a .plhtml extension for the templates instead of .html (this is entirely your choice).

Tenjin::Template, Catalyst::View::Tenjin, Dancer::Template::Tenjin.

CHANGES

Upon upgrading to versions 0.05 and above, you MUST perform the following changes for your applications (or, if you're using Catalyst, you must also upgrade Catalyst::View::Tenjin):

• "use Tenjin" as your normally would, but to get an instance of Tenjin you must call "Tenjin->new()" instead of the old method of calling "Tenjin::Engine->new()".
• Remove all your templates cache files (they are the '.cache' files in your template directories), they are not compatible with the new templates structure and WILL cause your application to fail if present.

Version 0.06 (this version) restored the layout template feature which was accidentaly missing in version 0.05, and the ability to call the utility methods of Tenjin::Util natively inside templates. You will want to remove your templates' .cache files when upgrading to 0.6 too.

AUTHOR

Development of Tenjin is done with github at <http://github.com/ido50/Tenjin>.

ACKNOWLEDGEMENTS

• Makoto Kuwata

  The original developer of Tenjin.

• John Beppu <beppu at cpan.org>

  For introducing me to Tenjin and helping me understand the way it's designed.

• Pedro Melo <melo at cpan.org>

  For helping me understand the logic behind some of the original Tenjin aspects and helping me fix bugs and create tests.

BUGS

SUPPORT

    perldoc Tenjin

You can also look for information at:

• RT: CPAN's request tracker

  <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Tenjin>

• AnnoCPAN: Annotated CPAN documentation

  <http://annocpan.org/dist/Tenjin>

• CPAN Ratings

  <http://cpanratings.perl.org/d/Tenjin>

• Search CPAN

  <http://search.cpan.org/dist/Tenjin/>

LICENSE AND COPYRIGHT

        Copyright (c) 2007-2011 the aforementioned authors.

        Permission is hereby granted, free of charge, to any person obtaining
        a copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:

        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.

        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

See http://dev.perl.org/licenses/ for more information.