Jens Rehsack > Report-Generator-0.002 > Report::Generator::Render::TT2

Download:
Report-Generator-0.002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.002   Source  

NAME ^

Report::Generator::Render::TT2 - class for rendering reports using TT2

SYNOPSIS ^

    my %cfg = (
         renderer => 'Report::Generator::Render::TT2',
         'Report::Generator::Render::TT2' => {
             config => { ABSOLUTE => 1, },
             output => 'test1.ext',
             vars => { },
             template => 'test1.tt2',
             options => {},
         },
    );
    Report::Generator->new({cfg => \%cfg})->generate();

DESCRIPTION ^

Report::Generator::Render::TT2 provides a base class for rendering reports in Report::Generator using Template::Toolkit.

See the test*.tt2 examples in the examples directory of this distribution to get a sense who to use this renderer.

SUBROUTINES/METHODS ^

new

Instantiates a new TT2 renderer for Report::Generator.

    Report::Generator::Render::TT2->new(
        {
            config   => { ... },
            vars     => { ... },
            options  => { ... },
            template => 'path/to/template',
            output   => 'path/to/output',
        }
    );

The parameters config, <vars> and <options> are optional, template and output are mandatory.

If the config parameter hash contains a flag FIXED_INCLUDE_PATH with a true value, the next paragraph can be skipped.

When the config parameter hash doesn't contain a value for DELIMITER, it's set to ; (semicolon) for the MSWin32 environment or to : (colon) otherwise. The value for INCLUDE_PATH is appended by the shared directory for this distribution.

render

Renders the given template into specified output using the given knobs. Returns a true value on success or sets $self->{error} otherwise.

AUTHOR ^

Jens Rehsack, <rehsack at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-report-generator at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Report-Generator. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Report::Generator::Render

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2010 Jens Rehsack.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

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

syntax highlighting: