1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "Template::Plugin::Dumper 3"
132 .TH Template::Plugin::Dumper 3 "2008-11-13" "perl v5.8.7" "User Contributed Perl Documentation"
134 Template::Plugin::Dumper \- Plugin interface to Data::Dumper
136 .IX Header "SYNOPSIS"
142 \& [% Dumper.dump(variable) %]
143 \& [% Dumper.dump_html(variable) %]
146 .IX Header "DESCRIPTION"
147 This is a very simple Template Toolkit Plugin Interface to the Data::Dumper
148 module. A \f(CW\*(C`Dumper\*(C'\fR object will be instantiated via the following directive:
154 As a standard plugin, you can also specify its name in lower case:
160 The \f(CW\*(C`Data::Dumper\*(C'\fR \f(CW\*(C`Pad\*(C'\fR, \f(CW\*(C`Indent\*(C'\fR and \f(CW\*(C`Varname\*(C'\fR options are supported
161 as constructor arguments to affect the output generated. See Data::Dumper
165 \& [% USE dumper(Indent=0, Pad="<br>") %]
168 These options can also be specified in lower case.
171 \& [% USE dumper(indent=0, pad="<br>") %]
175 There are two methods supported by the \f(CW\*(C`Dumper\*(C'\fR object. Each will
176 output into the template the contents of the variables passed to the
179 .IX Subsection "dump()"
180 Generates a raw text dump of the data structure(s) passed
184 \& [% Dumper.dump(myvar) %]
185 \& [% Dumper.dump(myvar, yourvar) %]
187 .Sh "\fIdump_html()\fP"
188 .IX Subsection "dump_html()"
189 Generates a dump of the data structures, as per \fIdump()\fR, but with the
190 characters <, > and & converted to their equivalent \s-1HTML\s0
191 entities and newlines converted to <br>.
195 \& [% Dumper.dump_html(myvar) %]
199 Simon Matthews <sam@tt2.org>
201 .IX Header "COPYRIGHT"
202 Copyright (C) 2000 Simon Matthews. All Rights Reserved.
204 This module is free software; you can redistribute it and/or
205 modify it under the same terms as Perl itself.
207 .IX Header "SEE ALSO"
208 Template::Plugin, Data::Dumper