The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

POLETTIX / Mojolicious-Plugin-TemplatePerlish-0.002 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

              
NAME
    Mojolicious::Plugin::TemplatePerlish - Template::Perlish renderer
    plugin for Mojolicious
VERSION
    This document describes Mojolicious::Plugin::TemplatePerlish version
    0.002.
SYNOPSIS
       # Mojolicious
       $app->plugin('TemplatePerlish');
       $app->plugin(TemplatePerlish => {name => 'tpt'});
       $app->plugin(TemplatePerlish => {template_perlish => {start => '<%', stop => '%>'}});
     
       # Mojolicious::Lite
       plugin 'TemplatePerlish';
       plugin TemplatePerlish => {name => 'tpt'};
       plugin TemplatePerlish => {template_perlish => {start => '<%', stop => '%>'}});
     
       # Set as default handler, default name is 'tp'
       $app->renderer->default_handler('tp');
     
       # Render without setting as default handler
       $c->render(template => 'foo', handler => 'tp');
DESCRIPTION
    Mojolicious::Plugin::TemplatePerlish is a renderer for
    Template::Perlish templates. See Template::Perlish for details on the
    template format and available opitons, and
    Mojolicious::Guides::Rendering for general information on rendering in
    Mojolicious.
    Mojolicious helpers and stash values will be exposed directly as
    variables in the templates, and the current controller object will be
    available as c or self, similar to Mojolicious::Plugin::EPRenderer. See
    Mojolicious::Plugin::DefaultHelpers and Mojolicious::Plugin::TagHelpers
    for a list of all built-in helpers.
       $c->stash(description => 'template engine');
       $c->stash(engines => [qw(Template::Perlish Template::Toolkit)]);
     
       [% for my $engine (A 'engines') { %]
          [% engine %] is a [% description %].
       [% } %]
     
       [%= V('link_to')->('Perl', 'http://www.perl.org') %]
    Along with standard template files, inline and data section templates
    can be rendered in the standard way. Template files and data sections
    will be retrieved using Mojolicious::Renderer, so you should set
    "paths" in Mojolicious::Renderer to the appropriate paths towards the
    templates.
OPTIONS
    The following options are supported.
 cache
       # Mojolicious::Lite
       plugin TemplatePerlish => {cache => 0};
    By default this plugin caches templates to avoid recompiling the over
    and over. If you plan to have a long running job, or a lot of
    templates, you can disable caching passing a false value (like in the
    example above). A true value enables caching. If you pass a hash
    reference, it will be used as cache (so you can e.g. pre-populate it
    with subroutines, see "compile_as_sub" in Template::Perlish).
 name
       # Mojolicious::Lite
       plugin TemplatePerlish => {name => 'foo'};
    Handler name, defaults to tp.
 read_binmode
       # Mojolicious::Lite
       plugin TemplatePerlish => {read_binmode => ':raw'};
    When a template is loaded from a file, this is the binmode that is
    applied upon opening the file. Defaults to the string :encoding(UTF-8).
 template_perlish
       # Mojolicious::Lite
       plugin TemplatePerlish => {
          template_perlish => {
             start => '<%', # default is '[%'
             stop  => '%>', # default is '%]'
             variables => {foo => bar}, # default is {}
          }
       };
    Options for Template::Perlish constructor.
METHODS
 register
       $plugin->register(Mojolicious->new());
       $plugin->register(Mojolicious->new(), {name => 'foo'});
    Register renderer in Mojolicious application.
BUGS AND LIMITATIONS
    Report bugs either through RT or GitHub (patches welcome).
SEE ALSO
    Mojolicious. Most of the documentation and tests is copied from
    Mojolicious::Plugin::TemplateToolkit.
AUTHOR
    Flavio Poletti <polettix@cpan.org>
COPYRIGHT AND LICENSE
    Copyright (C) 2016 by Flavio Poletti <polettix@cpan.org>
    This module is free software. You can redistribute it and/or modify it
    under the terms of the Artistic License 2.0.
    This program is distributed in the hope that it will be useful, but
    without any warranty; without even the implied warranty of
    merchantability or fitness for a particular purpose.