GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CGI::APPLICATION::PLUGIN::ANYTEMPLATE::DRIVER::PETAL (3)

.ds Aq ’

NAME

CGI::Application::Plugin::AnyTemplate::Driver::Petal - Petal plugin to AnyTemplate

CONTENTS

DESCRIPTION

This is a driver for CGI::Application::Plugin::AnyTemplate, which provides the implementation details specific to rendering templates via the Petal templating system.

All AnyTemplate drivers are designed to be used the same way. For general usage instructions, see the documentation of CGI::Application::Plugin::AnyTemplate.

EMBEDDED COMPONENT SYNTAX (Petal)

<B>Note that for embedding component to work properly in Petal, you need to encloseB> <B>the contents of the included file in tags, such as B><span><B> tags.B>



    <span>
    var: <span petal:replace="var"></span>
    </span>



The Petal syntax for embedding components is:



    <span tal:replace="structure CGIAPP/embed some_run_mode some_param1 some_param2 some literal string 3">
        this text gets replaced by the output of some_run_mode
    </span>



This can be overridden by the following configuration variables:



    embed_tag_name       # default CGIAPP



For instance by setting the following values in your configuration file:



    embed_tag_name       MYAPP



Then the embedded component tag will look like:



    <span tal:replace="structure MYAPP/embed some_run_mode">
        this text gets replaced by the output of some_run_mode
    </span>



Note that when creating documents to be included as components, they must be complete XML documents.

CONFIGURATION

The CGI::Application::Plugin::AnyTemplate::Driver::Petal driver accepts the following config parameters:
embed_tag_name The name of the tag used for embedding components. Defaults to CGIAPP.
template_extension If auto_add_template_extension is true, then CGI::Application::Plugin::AnyTemplate will append the value of template_extension to filename. By default the template_extension is .xhtml.
emulate_associate_query <B>This feature is now deprecated and will be removed in a future release.B>

If this config parameter is true, then CGI::Application::Plugin::AnyTemplate::Driver::Petal will copy all of the webapp’s query params into the template.

This is similar to what would happen if you used HTML::Template’s associate feature with the webapp’s query object:



    my $driver = HTML::Template->new(
        associate => $self->query,
    );



By default emulate_associate_query is false.

All other configuration parameters are passed on unchanged to Petal.

    required_modules

The required_modules function returns the modules required for this driver to operate. In this case: Petal.

DRIVER METHODS

initialize Initializes the Petal driver. See the docs for CGI::Application::Plugin::AnyTemplate::Base for details.
render_template Fills the Petal object with $self->param

If the param emulate_associate_query is true, then set params for each of $self->{’webapp’}->query, mimicking HTML::Template’s associate mechanism.

Also set up a CGI::Application::Plugin::AnyTemplate::ComponentHandler object so that the CGIAPP.embed callback will work.

Returns the output of the filled template as a string reference.

See the docs for CGI::Application::Plugin::AnyTemplate::Base for details.

SEE ALSO



    CGI::Application::Plugin::AnyTemplate
    CGI::Application::Plugin::AnyTemplate::Base
    CGI::Application::Plugin::AnyTemplate::ComponentHandler
    CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplate
    CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr
    CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplatePluggable
    CGI::Application::Plugin::AnyTemplate::Driver::TemplateToolkit
    CGI::Application::Plugin::AnyTemplate::Driver::Petal

    CGI::Application

    Template::Toolkit
    HTML::Template

    HTML::Template::Pluggable
    HTML::Template::Plugin::Dot

    Petal

    Exporter::Renaming

    CGI::Application::Plugin::TT



AUTHOR

Michael Graham, <mgraham@cpan.org>

COPYRIGHT & LICENSE

Copyright 2005 Michael Graham, All Rights Reserved.

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 CGI::APPLICATION::PLUGIN::ANYTEMPLATE::DRIVER::PETAL (3) 2016-03-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.