-
Notifications
You must be signed in to change notification settings - Fork 12
/
README
385 lines (280 loc) · 11.8 KB
/
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
NAME
Template::Flute - Modern designer-friendly HTML templating Engine
VERSION
Version 0.0020
SYNOPSIS
use Template::Flute;
my ($cart, $flute, %values);
$cart = [{...},{...}];
$values{cost} = ...
$flute = new Template::Flute(specification_file => 'cart.xml',
template_file => 'cart.html',
iterators => {cart => $cart},
values => \%values,
);
print $flute->process();
DESCRIPTION
Template::Flute enables you to completely separate web design and
programming tasks for dynamic web applications.
Templates are designed to be designer-friendly; there's no inline code
or mini templating language for your designers to learn - instead,
standard HTML and CSS classes are used, leading to HTML that can easily
be understood and edited by WYSIWYG editors and hand-coding designers
alike.
An example is easier than a wordy description:
Given the following template snippet:
<div class="customer_name">Mr A Test</div>
<div class="customer_email">someone@example.com</div>
and the following specification:
<specification name="example" description="Example">
<value name="customer_name" />
<value name="email" field="customer_email" />
</specification>
Processing the above as follows:
$flute = Template::Flute->new(
template_file => 'template.html',
specification_file => 'spec.xml',
);
$flute->set_values({
customer_name => 'Bob McTest',
email => 'bob@example.com',
});;
print $flute->process;
The resulting output would be:
<div class="customer_name">Bob McTest</div>
<div class="email">bob@example.com</div>
In other words, rather than including a templating language within your
templates which your designers must master and which could interfere
with previews in WYSWYG tools, CSS selectors in the template are tied to
your data structures or objects by a specification provided by the
programmer.
Workflow
The easiest way to use Template::Flute is to pass all necessary
parameters to the constructor and call the process method to generate
the HTML.
You can also break it down in separate steps:
1. Parse specification
Parse specification based on your specification format (e.g with
Template::Flute::Specification::XML or
Template::Flute::Specification::Scoped.).
$xml_spec = new Template::Flute::Specification::XML;
$spec = $xml_spec->parse(q{<specification name="cart" description="Cart">
<list name="cart" class="cartitem" iterator="cart">
<param name="name" field="title"/>
<param name="quantity"/>
<param name="price"/>
</list>
<value name="cost"/>
</specification>});
2. Parse template
Parse template with Template::Flute::HTML object.
$template = new Template::Flute::HTML;
$template->parse(q{<html>
<head>
<title>Cart Example</title>
</head>
<body>
<table class="cart">
<tr class="cartheader">
<th>Name</th>
<th>Quantity</th>
<th>Price</th>
</tr>
<tr class="cartitem">
<td class="name">Sample Book</td>
<td><input class="quantity" name="quantity" size="3" value="10"></td>
<td class="price">$1</td>
</tr>
<tr class="cartheader"><th colspan="2"></th><th>Total</th>
</tr>
<tr>
<td colspan="2"></td><td class="cost">$10</td>
</tr>
</table>
</body></html>},
$spec);
3. Produce HTML output
$flute = new Template::Flute(template => $template,
iterators => {cart => $cart},
values => {cost => '84.94'});
$flute->process();
CONSTRUCTOR
new
Create a Template::Flute object with the following parameters:
specification_file
Specification file name.
specification_parser
Select specification parser. This can be either the full class name
like MyApp::Specification::Parser or the last part for classes
residing in the Template::Flute::Specification namespace.
specification
Specification object or specification as string.
template_file
HTML template file.
template
Template::Flute::HTML object or template as string.
database
Template::Flute::Database::Rose object.
filters
Hash reference of filter functions.
i18n
Template::Flute::I18N object.
iterators
Hash references of iterators.
values
Hash reference of values to be used by the process method.
auto_iterators
Builds iterators automatically from values.
METHODS
process [HASHREF]
Processes HTML template, manipulates the HTML tree based on the
specification, values and iterators.
Returns HTML output.
process_template
Processes HTML template and returns Template::Flute::HTML object.
filter ELEMENT VALUE
Runs the filter used by ELEMENT on VALUE and returns the result.
value NAME
Returns the value for NAME.
set_values HASHREF
Sets hash reference of values to be used by the process method. Same as
passing the hash reference as values argument to the constructor.
template
Returns HTML template object, see Template::Flute::HTML for details.
specification
Returns specification object, see Template::Flute::Specification for
details.
SPECIFICATION
The specification ties the elements in the HTML template to the data
(variables, lists, forms) which is added to the template.
The default format for the specification is XML implemented by the
Template::Flute::Specification::XML module. You can use the
Config::Scoped format implemented by
Template::Flute::Specification::Scoped module or write your own
specification parser class.
Possible elements in the specification are:
container
The first container is only shown in the output if the value
`billing_address' is set:
<container name="billing" value="billing_address" class="billingWrapper">
</container>
The second container is shown if the value `warnings' or the value
`errors' is set:
<container name="account_errors" value="warnings|errors" class="infobox">
<value name="warnings"/>
<value name="errors"/>
</container>
list
separator
Separator elements for list are added after any list item in the
output with the exception of the last one.
Example specification, HTML template and output:
<specification>
<list name="list" iterator="tokens">
<param name="key"/>
<separator name="sep"/>
</list>
</specification>
<div class="list"><span class="key">KEY</span></div><span class="sep"> | </span>
<div class="list"><span class="key">FOO</span></div><span class="sep"> | </span>
<div class="list"><span class="key">BAR</span></div>
param
value
Value elements are replaced with a single value present in the
values hash passed to the constructor of this class or later set
with the set_values method.
The following operations are supported for value elements:
hook
Insert HTML residing in value as subtree of the corresponding
HTML element. HTML will be parsed with XML::Twig.
toggle
Only shows corresponding HTML element if value is set.
Other attributes for value elements are:
include
Processes the template file named in this attribute. This
implies the hook operation.
input
filter
sort
i18n
ITERATORS
Template::Flute uses iterators to retrieve list elements and insert them
into the document tree. This abstraction relieves us from worrying about
where the data actually comes from. We basically just need an array of
hash references and an iterator class with a next and a count method.
For your convenience you can create an iterator from
Template::Flute::Iterator class very easily.
LISTS
Lists can be accessed after parsing the specification and the HTML
template through the HTML template object:
$flute->template->lists();
$flute->template->list('cart');
Only lists present in the specification and the HTML template can be
addressed in this way.
See Template::Flute::List for details about lists.
FORMS
Forms can be accessed after parsing the specification and the HTML
template through the HTML template object:
$flute->template->forms();
$flute->template->form('edit_content');
Only forms present in the specification and the HTML template can be
addressed in this way.
See Template::Flute::Form for details about lists.
FILTERS
Filters are used to change the display of value and param elements in
the resulting HTML output:
<value name="billing_address" filter="eol"/>
<param name="price" filter="currency"/>
The following filters are included:
upper
Uppercase filter, see Template::Flute::Filter::Upper.
eol Filter preserving line breaks, see Template::Flute::Filter::Eol.
nobreak_single
Filter replacing missing text with no-break space, see
Template::Flute::Filter::NobreakSingle.
currency
Currency filter, see Template::Flute::Filter::Currency.
date
Date filter, see Template::Flute::Filter::Date.
INCLUDES
Files, especially components for web pages can be processed and included
through value elements with the include attribute:
<value name="sidebar" include="component.html"/>
The result replaces the inner HTML of the following `div' tag:
<div class="sidebar">
Sample content
</div>
AUTHOR
Stefan Hornburg (Racke), <racke@linuxia.de>
BUGS
Please report any bugs or feature requests to `bug-template-flute at
rt.cpan.org', or through the web interface at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Template-Flute.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Template::Flute
You can also look for information at:
* RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Template-Flute
* AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Template-Flute
* CPAN Ratings
http://cpanratings.perl.org/d/Template-Flute
* Search CPAN
http://search.cpan.org/dist/Template-Flute/
ACKNOWLEDGEMENTS
Thanks to David Previous (bigpresh) for writing a much clearer
introduction for Template::Flute.
Thanks to Ton Verhagen for being a big supporter of my projects in all
aspects.
Thanks to Terrence Brannon for spotting a documentation mix-up.
HISTORY
Template::Flute was initially named Template::Zoom. I renamed the module
because of a request from Matt S. Trout, author of the HTML::Zoom
module.
LICENSE AND COPYRIGHT
Copyright 2010-2011 Stefan Hornburg (Racke) <racke@linuxia.de>.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.