.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LaTeX::Table::Types::TypeI 3pm"
.TH LaTeX::Table::Types::TypeI 3pm "2013-09-22" "perl v5.18.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
LaTeX::Table::Types::TypeI \- Interface for LaTeX table types.
.SH "DESCRIPTION"
.IX Header "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 \*(L"\s-1TEMPLATE
VARIABLES\*(R"\s0. LaTeX::Table ships with very flexible templates, but it is
possible to use the template variables defined here to build custom templates.
.SH "INTERFACE"
.IX Header "INTERFACE"
.ie n .IP """generate_latex_code""" 4
.el .IP "\f(CWgenerate_latex_code\fR" 4
.IX Item "generate_latex_code"
.SH "TEMPLATE VARIABLES"
.IX Header "TEMPLATE VARIABLES"
Most options are accessible here:
.ie n .IP """CENTER, LEFT, RIGHT""" 4
.el .IP "\f(CWCENTER, LEFT, RIGHT\fR" 4
.IX Item "CENTER, LEFT, RIGHT"
Example:
.Sp
.Vb 2
\&  [% IF CENTER %]\ecentering
\&  [% END %]
.Ve
.ie n .IP """ENVIRONMENT, STAR, POSITION, SIDEWAYS""" 4
.el .IP "\f(CWENVIRONMENT, STAR, POSITION, SIDEWAYS\fR" 4
.IX Item "ENVIRONMENT, STAR, POSITION, SIDEWAYS"
These options for floating environments are typically used like:
.Sp
.Vb 7
\&  [% IF ENVIRONMENT %]\ebegin{[% ENVIRONMENT %][% IF STAR %]*[% END %]}[% IF POSITION %][[% POSITION %]][% END %]
\&  ...
\&  [% END %]
\&  # the tabular environment here
\&  ...
\&  [% IF ENVIRONMENT %] ...
\&  \eend{[% ENVIRONMENT %][% IF STAR %]*[% END %]}[% END %]
.Ve
.ie n .IP """CAPTION_TOP, CAPTION_CMD, SHORTCAPTION, CAPTION, CONTINUED, CONTINUEDMSG""" 4
.el .IP "\f(CWCAPTION_TOP, CAPTION_CMD, SHORTCAPTION, CAPTION, CONTINUED, CONTINUEDMSG\fR" 4
.IX Item "CAPTION_TOP, CAPTION_CMD, SHORTCAPTION, CAPTION, CONTINUED, CONTINUEDMSG"
The variables to build the caption command. Note that there is \s-1NO\s0 template for
the \f(CW\*(C`maincaption\*(C'\fR option. \f(CW\*(C`CAPTION\*(C'\fR already includes this maincaption if
specified.
.ie n .IP """LABEL""" 4
.el .IP "\f(CWLABEL\fR" 4
.IX Item "LABEL"
The label:
.Sp
.Vb 1
\& [% IF LABEL %]\elabel{[% LABEL %]}[% END %]
.Ve
.ie n .IP """TABULAR_ENVIRONMENT, WIDTH, COLDEF""" 4
.el .IP "\f(CWTABULAR_ENVIRONMENT, WIDTH, COLDEF\fR" 4
.IX Item "TABULAR_ENVIRONMENT, WIDTH, COLDEF"
These three options define the tabular environment:
.Sp
.Vb 1
\&  \ebegin{[% TABULAR_ENVIRONMENT %]}[% IF WIDTH %]{[% WIDTH %]}[% END %]{[% COLDEF %]}
.Ve
.ie n .IP """FONTFAMILY, FONTSIZE""" 4
.el .IP "\f(CWFONTFAMILY, FONTSIZE\fR" 4
.IX Item "FONTFAMILY, FONTSIZE"
Example:
.Sp
.Vb 3
\&  [% IF FONTSIZE %]\e[% FONTSIZE %]
\&  [% END %][% IF FONTFAMILY %]\e[% FONTFAMILY %]family
\&  [% END %]
.Ve
.ie n .IP """TABLEHEADMSG, TABLETAIL, TABLELASTTAIL, XENTRYSTRETCH""" 4
.el .IP "\f(CWTABLEHEADMSG, TABLETAIL, TABLELASTTAIL, XENTRYSTRETCH\fR" 4
.IX Item "TABLEHEADMSG, TABLETAIL, TABLELASTTAIL, XENTRYSTRETCH"
For the multi-page tables.
.ie n .IP """MAXWIDTH, FOOTTABLE""" 4
.el .IP "\f(CWMAXWIDTH, FOOTTABLE\fR" 4
.IX Item "MAXWIDTH, FOOTTABLE"
Currently only used by LaTeX::Table::Types::Ctable.
.PP
In addition, some variables already contain formatted LaTeX code:
.ie n .IP """HEADER_CODE""" 4
.el .IP "\f(CWHEADER_CODE\fR" 4
.IX Item "HEADER_CODE"
The formatted header:
.Sp
.Vb 5
\&  \etoprule
\&  \emulticolumn{2}{c}{Item} &             \e\e
\&  \ecmidrule(r){1\-2}
\&  Animal                   & Description & Price \e\e
\&  \emidrule
.Ve
.ie n .IP """DATA_CODE""" 4
.el .IP "\f(CWDATA_CODE\fR" 4
.IX Item "DATA_CODE"
The formatted data:
.Sp
.Vb 6
\&  Gnat      & per gram & 13.65 \e\e
\&            & each     & 0.01  \e\e
\&  Gnu       & stuffed  & 92.59 \e\e
\&  Emu       & stuffed  & 33.33 \e\e
\&  Armadillo & frozen   & 8.99  \e\e
\&  \ebottomrule
.Ve
.ie n .IP """RESIZEBOX_BEGIN_CODE, RESIZEBOX_END_CODE""" 4
.el .IP "\f(CWRESIZEBOX_BEGIN_CODE, RESIZEBOX_END_CODE\fR" 4
.IX Item "RESIZEBOX_BEGIN_CODE, RESIZEBOX_END_CODE"
Everything between these two template variables is resized according the
\&\f(CW\*(C`resizebox\*(C'\fR option.
.ie n .IP """EXTRA_ROW_HEIGHT_CODE, DEFINE_COLORS_CODE, RULES_COLOR_GLOBAL_CODE, RULES_WIDTH_GLOBAL_CODE""" 4
.el .IP "\f(CWEXTRA_ROW_HEIGHT_CODE, DEFINE_COLORS_CODE, RULES_COLOR_GLOBAL_CODE, RULES_WIDTH_GLOBAL_CODE\fR" 4
.IX Item "EXTRA_ROW_HEIGHT_CODE, DEFINE_COLORS_CODE, RULES_COLOR_GLOBAL_CODE, RULES_WIDTH_GLOBAL_CODE"
Specified by the theme. \f(CW\*(C`EXTRA_ROW_HEIGHT_CODE\*(C'\fR will contain the
corresponding LaTeX extrarowheight command, e.g for '1pt':
.Sp
.Vb 1
\&    \esetlength{\eextrarowheight}{1pt}
.Ve
.Sp
Otherwise it will contain the empty string. The other template variables will
contain the command specified by the corresponding theme option.
.PP
Finally, some variables allow access to internal \f(CW\*(C`LaTeX::Table\*(C'\fR variables:
.ie n .IP """LT_NUM_COLUMNS""" 4
.el .IP "\f(CWLT_NUM_COLUMNS\fR" 4
.IX Item "LT_NUM_COLUMNS"
Contains the number of columns of the table.
.ie n .IP """LT_BOTTOM_RULE_CODE""" 4
.el .IP "\f(CWLT_BOTTOM_RULE_CODE\fR" 4
.IX Item "LT_BOTTOM_RULE_CODE"
Code that draws the rules at the bottom of the table according the theme
options.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
LaTeX::Table
.PP
The predefined templates: LaTeX::Table::Types::Std,
LaTeX::Table::Types::Ctable, LaTeX::Table::Types::Longtable,
LaTeX::Table::Types::Xtab
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2006\-2010 \f(CW\*(C`<limaone@cpan.org>\*(C'\fR
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.