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
LaTeX::Table::Types::TypeI(3pm) User Contributed Perl Documentation LaTeX::Table::Types::TypeI(3pm)NAME
LaTeX::Table::Types::TypeI - Interface for LaTeX table types.
DESCRIPTION
This is the type interface (or Moose role), that all type objects must use. LaTeX::Table delegates the LaTeX code generation to type
objects. It stores all information we have in easy to use "TEMPLATE VARIABLES". LaTeX::Table ships with very flexible templates, but it is
possible to use the template variables defined here to build custom templates.
INTERFACE
"generate_latex_code"
TEMPLATE VARIABLES
Most options are accessible here:
"CENTER, LEFT, RIGHT"
Example:
[% IF CENTER %]centering
[% END %]
"ENVIRONMENT, STAR, POSITION, SIDEWAYS"
These options for floating environments are typically used like:
[% IF ENVIRONMENT %]egin{[% ENVIRONMENT %][% IF STAR %]*[% END %]}[% IF POSITION %][[% POSITION %]][% END %]
...
[% END %]
# the tabular environment here
...
[% IF ENVIRONMENT %] ...
end{[% ENVIRONMENT %][% IF STAR %]*[% END %]}[% END %]
"CAPTION_TOP, CAPTION_CMD, SHORTCAPTION, CAPTION, CONTINUED, CONTINUEDMSG"
The variables to build the caption command. Note that there is NO template for the "maincaption" option. "CAPTION" already includes
this maincaption if specified.
"LABEL"
The label:
[% IF LABEL %]label{[% LABEL %]}[% END %]
"TABULAR_ENVIRONMENT, WIDTH, COLDEF"
These three options define the tabular environment:
egin{[% TABULAR_ENVIRONMENT %]}[% IF WIDTH %]{[% WIDTH %]}[% END %]{[% COLDEF %]}
"FONTFAMILY, FONTSIZE"
Example:
[% IF FONTSIZE %][% FONTSIZE %]
[% END %][% IF FONTFAMILY %][% FONTFAMILY %]family
[% END %]
"TABLEHEADMSG, TABLETAIL, TABLELASTTAIL, XENTRYSTRETCH"
For the multi-page tables.
"MAXWIDTH, FOOTTABLE"
Currently only used by LaTeX::Table::Types::Ctable.
In addition, some variables already contain formatted LaTeX code:
"HEADER_CODE"
The formatted header:
oprule
multicolumn{2}{c}{Item} & \
cmidrule(r){1-2}
Animal & Description & Price \
midrule
"DATA_CODE"
The formatted data:
Gnat & per gram & 13.65 \
& each & 0.01 \
Gnu & stuffed & 92.59 \
Emu & stuffed & 33.33 \
Armadillo & frozen & 8.99 \
ottomrule
"RESIZEBOX_BEGIN_CODE, RESIZEBOX_END_CODE"
Everything between these two template variables is resized according the "resizebox" option.
"EXTRA_ROW_HEIGHT_CODE, DEFINE_COLORS_CODE, RULES_COLOR_GLOBAL_CODE, RULES_WIDTH_GLOBAL_CODE"
Specified by the theme. "EXTRA_ROW_HEIGHT_CODE" will contain the corresponding LaTeX extrarowheight command, e.g for '1pt':
setlength{extrarowheight}{1pt}
Otherwise it will contain the empty string. The other template variables will contain the command specified by the corresponding theme
option.
Finally, some variables allow access to internal "LaTeX::Table" variables:
"LT_NUM_COLUMNS"
Contains the number of columns of the table.
"LT_BOTTOM_RULE_CODE"
Code that draws the rules at the bottom of the table according the theme options.
SEE ALSO
LaTeX::Table
The predefined templates: LaTeX::Table::Types::Std, LaTeX::Table::Types::Ctable, LaTeX::Table::Types::Longtable, LaTeX::Table::Types::Xtab
LICENSE AND COPYRIGHT
Copyright (c) 2006-2010 "<limaone@cpan.org>"
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
perl v5.10.1 2010-10-27 LaTeX::Table::Types::TypeI(3pm)