Commit | Line | Data |
3fea05b9 |
1 | .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10) |
2 | .\" |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
5 | .de Sp \" Vertical space (when we can't use .PP) |
6 | .if t .sp .5v |
7 | .if n .sp |
8 | .. |
9 | .de Vb \" Begin verbatim text |
10 | .ft CW |
11 | .nf |
12 | .ne \\$1 |
13 | .. |
14 | .de Ve \" End verbatim text |
15 | .ft R |
16 | .fi |
17 | .. |
18 | .\" Set up some character translations and predefined strings. \*(-- will |
19 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
20 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
21 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
22 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
23 | .\" nothing in troff, for use with C<>. |
24 | .tr \(*W- |
25 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
26 | .ie n \{\ |
27 | . ds -- \(*W- |
28 | . ds PI pi |
29 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
30 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
31 | . ds L" "" |
32 | . ds R" "" |
33 | . ds C` "" |
34 | . ds C' "" |
35 | 'br\} |
36 | .el\{\ |
37 | . ds -- \|\(em\| |
38 | . ds PI \(*p |
39 | . ds L" `` |
40 | . ds R" '' |
41 | 'br\} |
42 | .\" |
43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
44 | .ie \n(.g .ds Aq \(aq |
45 | .el .ds Aq ' |
46 | .\" |
47 | .\" If the F register is turned on, we'll generate index entries on stderr for |
48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
50 | .\" output yourself in some meaningful fashion. |
51 | .ie \nF \{\ |
52 | . de IX |
53 | . tm Index:\\$1\t\\n%\t"\\$2" |
54 | .. |
55 | . nr % 0 |
56 | . rr F |
57 | .\} |
58 | .el \{\ |
59 | . de IX |
60 | .. |
61 | .\} |
62 | .\" |
63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
64 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
65 | . \" fudge factors for nroff and troff |
66 | .if n \{\ |
67 | . ds #H 0 |
68 | . ds #V .8m |
69 | . ds #F .3m |
70 | . ds #[ \f1 |
71 | . ds #] \fP |
72 | .\} |
73 | .if t \{\ |
74 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
75 | . ds #V .6m |
76 | . ds #F 0 |
77 | . ds #[ \& |
78 | . ds #] \& |
79 | .\} |
80 | . \" simple accents for nroff and troff |
81 | .if n \{\ |
82 | . ds ' \& |
83 | . ds ` \& |
84 | . ds ^ \& |
85 | . ds , \& |
86 | . ds ~ ~ |
87 | . ds / |
88 | .\} |
89 | .if t \{\ |
90 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
91 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
92 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
93 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
94 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
95 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
96 | .\} |
97 | . \" troff and (daisy-wheel) nroff accents |
98 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
99 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
100 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
101 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
102 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
103 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
104 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
105 | .ds ae a\h'-(\w'a'u*4/10)'e |
106 | .ds Ae A\h'-(\w'A'u*4/10)'E |
107 | . \" corrections for vroff |
108 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
109 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
110 | . \" for low resolution devices (crt and lpr) |
111 | .if \n(.H>23 .if \n(.V>19 \ |
112 | \{\ |
113 | . ds : e |
114 | . ds 8 ss |
115 | . ds o a |
116 | . ds d- d\h'-1'\(ga |
117 | . ds D- D\h'-1'\(hy |
118 | . ds th \o'bp' |
119 | . ds Th \o'LP' |
120 | . ds ae ae |
121 | . ds Ae AE |
122 | .\} |
123 | .rm #[ #] #H #V #F C |
124 | .\" ======================================================================== |
125 | .\" |
126 | .IX Title "Timer 3" |
127 | .TH Timer 3 "2009-03-07" "perl v5.8.7" "User Contributed Perl Documentation" |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
129 | .\" way too many mistakes in technical documents. |
130 | .if n .ad l |
131 | .nh |
132 | .SH "NAME" |
133 | Template::Timer \- Rudimentary profiling for Template Toolkit |
134 | .SH "VERSION" |
135 | .IX Header "VERSION" |
136 | Version 1.00 |
137 | .SH "SYNOPSIS" |
138 | .IX Header "SYNOPSIS" |
139 | Template::Timer provides inline timings of the template processing |
140 | througout your code. It's an overridden version of Template::Context |
141 | that wraps the \f(CW\*(C`process()\*(C'\fR and \f(CW\*(C`include()\*(C'\fR methods. |
142 | .PP |
143 | Using Template::Timer is simple. |
144 | .PP |
145 | .Vb 1 |
146 | \& use Template::Timer; |
147 | \& |
148 | \& my %config = ( # Whatever your config is |
149 | \& INCLUDE_PATH => \*(Aq/my/template/path\*(Aq, |
150 | \& COMPILE_EXT => \*(Aq.ttc\*(Aq, |
151 | \& COMPILE_DIR => \*(Aq/tmp/tt\*(Aq, |
152 | \& ); |
153 | \& |
154 | \& if ( $development_mode ) { |
155 | \& $config{ CONTEXT } = Template::Timer\->new( %config ); |
156 | \& } |
157 | \& |
158 | \& my $template = Template\->new( \e%config ); |
159 | .Ve |
160 | .PP |
161 | Now when you process templates, \s-1HTML\s0 comments will get embedded in your |
162 | output, which you can easily grep for. The nesting level is also shown. |
163 | .PP |
164 | .Vb 5 |
165 | \& <!\-\- TIMER START: L1 process mainmenu/mainmenu.ttml \-\-> |
166 | \& <!\-\- TIMER START: L2 include mainmenu/cssindex.tt \-\-> |
167 | \& <!\-\- TIMER START: L3 process mainmenu/cssindex.tt \-\-> |
168 | \& <!\-\- TIMER END: L3 process mainmenu/cssindex.tt (17.279 ms) \-\-> |
169 | \& <!\-\- TIMER END: L2 include mainmenu/cssindex.tt (17.401 ms) \-\-> |
170 | \& |
171 | \& .... |
172 | \& |
173 | \& <!\-\- TIMER END: L3 process mainmenu/footer.tt (3.016 ms) \-\-> |
174 | \& <!\-\- TIMER END: L2 include mainmenu/footer.tt (3.104 ms) \-\-> |
175 | \& <!\-\- TIMER END: L1 process mainmenu/mainmenu.ttml (400.409 ms) \-\-> |
176 | .Ve |
177 | .PP |
178 | Note that since \s-1INCLUDE\s0 is a wrapper around \s-1PROCESS\s0, calls to INCLUDEs |
179 | will be doubled up, and slightly longer than the \s-1PROCESS\s0 call. |
180 | .SH "AUTHOR" |
181 | .IX Header "AUTHOR" |
182 | Andy Lester, \f(CW\*(C`<andy at petdance.com>\*(C'\fR |
183 | .SH "BUGS" |
184 | .IX Header "BUGS" |
185 | Please report any bugs or feature requests to |
186 | \&\f(CW\*(C`bug\-template\-timer at rt.cpan.org\*(C'\fR, or through the web interface at |
187 | <http://rt.cpan.org>. I will be notified, and then you'll automatically |
188 | be notified of progress on your bug as I make changes. |
189 | .SH "ACKNOWLEDGEMENTS" |
190 | .IX Header "ACKNOWLEDGEMENTS" |
191 | Thanks to |
192 | Randal Schwartz, |
193 | Bill Moseley, |
194 | and to Gavin Estey for the original code. |
195 | .SH "COPYRIGHT & LICENSE" |
196 | .IX Header "COPYRIGHT & LICENSE" |
197 | This library is free software; you can redistribute it and/or modify |
198 | it under the terms of either the \s-1GNU\s0 Public License v3, or the Artistic |
199 | License 2.0. |
200 | .PP |
201 | .Vb 1 |
202 | \& * http://www.gnu.org/copyleft/gpl.html |
203 | \& |
204 | \& * http://www.opensource.org/licenses/artistic\-license\-2.0.php |
205 | .Ve |