latex::driver::filterprogram(3pm) [debian man page]
LaTeX::Driver::FilterProgram(3pm) User Contributed Perl Documentation LaTeX::Driver::FilterProgram(3pm)NAME
LaTeX::Driver::FilterProgram - LaTeX Driver (FilterProgram)
VERSION SYNOPSIS
use LaTeX::Driver::FilterProgram;
LaTeX::Driver::FilterProgram->execute(format => $format);
DESCRIPTION
This module is not intended to be used except by the programs "latex2pdf", "latex2ps" and "latex2dvi" that are included in the
LaTeX::Driver distribution. It implements the guts of those filter programs.
SUBROUTINES /METHODS
"execute(%params)"
This is the only method. It implements the guts of the filter programs, gathering the parameters for the "LaTeX::Driver" object
constructor from the command line options, along with the options passed from the calling script, which should be the format option.
Having constructed a driver object it then runs the driver.
If the "-tt2" option is specified then the source document is taken to be a Template Toolkit template and a Template object is
constructed and the template processed through that before being fed to the "LaTeX::Driver" module for latex formatting. Template
variables may defined with the "-define" option and these are passed to the Template Toolkit processing stage (they are ignored if the
"-tt2" option is not specified).
DIAGNOSTICS
The module invokes the "LaTeX::Driver" module and optionally the "Template" module. Any errors from those modules are propogated outwards.
CONFIGURATION AND ENVIRONMENT
The module invokes the latex family of programs via the "LaTeX::Driver" module. Those programs have their own set of environment variables
and configuration files.
DEPENDENCIES
The module requires that the Template Toolkit is installed for the "-tt2" option.
INCOMPATIBILITIES
None known.
BUGS AND LIMITATIONS
None known.
AUTHOR
Andrew Ford <a.ford@ford-mason.co.uk>
LICENSE AND COPYRIGHT
Copyright (C) 2007 Andrew Ford. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
perl v5.12.4 2011-09-18 LaTeX::Driver::FilterProgram(3pm)
Check Out this Related Man Page
CGI ::Application::Plugin::AnyTemplate::Driver::HTMLTemplUserxContributed Perl CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr(3pm)NAME
CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr - HTML::Template::Expr driver to AnyTemplate
DESCRIPTION
This is a driver for CGI::Application::Plugin::AnyTemplate, which provides the implementation details specific to rendering templates via
the HTML::Template::Expr 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 (HTML::Template::Expr)
Syntax
The HTML::Template::Expr syntax for embedding components is:
<TMPL_VAR EXPR="CGIAPP_embed('some_run_mode', param1, param2, 'literal string3')">
This can be overridden by the following configuration variables:
embed_tag_name # default 'CGIAPP_embed'
For instance by setting the following value in your configuration file:
embed_tag_name '__ACME_render'
Then the embedded component tag will look like:
<TMPL_VAR EXPR="__ACME_render('some_run_mode')">
The value of "embed_tag_name" must consist of numbers, letters and underscores ("_"), and must not begin with a number.
CONFIGURATION
The CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr driver accepts the following config parameters:
embed_tag_name
The name of the tag used for embedding components. Defaults to "CGIAPP_embed".
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 ".html".
associate_query
This feature is now deprecated and will be removed in a future release.
If this config parameter is true, then CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr will copy all of the webapp's
query params into the template using HTML::Template::Expr's "associate" mechanism:
my $driver = HTML::Template::Expr->new(
associate => $self->query,
);
By default "associate_query" is false.
If you provide an "associate" config parameter of your own, that will disable the "associate_query" functionality.
All other configuration parameters are passed on unchanged to HTML::Template::Expr.
required_modules
The "required_modules" function returns the modules required for this driver to operate. In this case: "HTML::Template::Expr".
DRIVER METHODS
initialize
Initializes the "HTMLTemplateExpr" driver. See the docs for CGI::Application::Plugin::AnyTemplate::Base for details.
render_template
Fills the HTML::Template::Expr object with "$self->param", and returns the output (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::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.
perl v5.10.12010-12-16CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr(3pm)