Jerome Eteve > LaTeX-CatSuit-1.00_05 > LaTeX::CatSuit::FilterProgram

Download:
LaTeX-CatSuit-1.00_05.tar.gz

Dependencies

Annotate this POD

Source  

NAME ^

LaTeX::CatSuit::FilterProgram

VERSION ^

SYNOPSIS ^

  use LaTeX::CatSuit::FilterProgram;
  LaTeX::CatSuit::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::CatSuit 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::CatSuit 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::CatSuit 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::CatSuit 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::CatSuit 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.

syntax highlighting: