.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "Dancer::Template::TemplateToolkit 3pm" .TH Dancer::Template::TemplateToolkit 3pm "2012-01-27" "perl v5.14.2" "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" Dancer::Template::TemplateToolkit \- Template Toolkit wrapper for Dancer .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class is an interface between Dancer's template engine abstraction layer and the Template module. .PP This template engine is recomended for production purposes, but depends on the Template module. .PP In order to use this engine, use the template setting: .PP .Vb 1 \& template: template_toolkit .Ve .PP This can be done in your config.yml file or directly in your app code with the \&\fBset\fR keyword. .PP Note that by default, Dancer configures the Template::Toolkit engine to use <% %> brackets instead of its default [% %] brackets. This can be changed within your config file \- for example: .PP .Vb 5 \& template: template_toolkit \& engines: \& template_toolkit: \& start_tag: \*(Aq[%\*(Aq \& stop_tag: \*(Aq%]\*(Aq .Ve .PP You can also add any options you would normally add to the Template module's initialization. You could, for instance, enable saving the compiled templates: .PP .Vb 4 \& engines: \& template_toolkit: \& COMPILE_DIR: \*(Aqcaches/templates\*(Aq \& COMPILE_EXT: \*(Aq.ttc\*(Aq .Ve .PP By default, Template is used, but you can configure Dancer to use a subclass with the \f(CW\*(C`subclass\*(C'\fR option. .PP .Vb 3 \& engines: \& template_toolkit: \& subclass: My::Template .Ve .SH "WRAPPER, META variables, SETs" .IX Header "WRAPPER, META variables, SETs" Dancer already provides a WRAPPER-like ability, which we call a \*(L"layout\*(R". The reason we do not use \s-1TT\s0's \s-1WRAPPER\s0 (which also makes it incompatible with it) is because not all template systems support it. Actually, most don't. .PP However, you might want to use it, and be able to define \s-1META\s0 variables and regular Template::Toolkit variables. .PP These few steps will get you there: .IP "\(bu" 4 Disable the layout in Dancer .Sp You can do this by simply commenting (or removing) the \f(CW\*(C`layout\*(C'\fR configuration in the \fIconfig.yml\fR file. .IP "\(bu" 4 Use Template Toolkit template engine .Sp Change the configuration of the template to Template Toolkit: .Sp .Vb 2 \& # in config.yml \& template: "template_toolkit" .Ve .IP "\(bu" 4 Tell the Template Toolkit engine who's your wrapper .Sp .Vb 5 \& # in config.yml \& # ... \& engines: \& template_toolkit: \& WRAPPER: layouts/main.tt .Ve .PP Done! Everything will work fine out of the box, including variables and \s-1META\s0 variables. .SH "SEE ALSO" .IX Header "SEE ALSO" Dancer, Template .SH "AUTHOR" .IX Header "AUTHOR" This module has been written by Alexis Sukrieh .SH "LICENSE" .IX Header "LICENSE" This module is free software and is released under the same terms as Perl itself.