Javascript Templates¶
Pipeline allows you to use javascript templates along with your javascript views. To use your javascript templates, just add them to your PIPELINE_JS group
PIPELINE_JS = {
'application': {
'source_filenames': (
'js/application.js',
'js/templates/**/*.jst',
),
'output_filename': 'js/application.js'
}
}
For example, if you have the following template js/templates/photo/detail.jst
<div class="photo">
<img src="<%= src %>" />
<div class="caption">
<%= caption %>
</div>
</div>
It will be available from your javascript code via window.JST
JST.photo_detail({ src:"images/baby-panda.jpg", caption:"A baby panda is born" });
Configuration¶
Template function¶
By default, Pipeline uses a variant of Micro Templating to compile the templates, but you can choose your preferred JavaScript templating engine by changing PIPELINE_TEMPLATE_FUNC
PIPELINE_TEMPLATE_FUNC = 'template'
Template namespace¶
Your templates are made available in a top-level object, by default window.JST, but you can choose your own via PIPELINE_TEMPLATE_NAMESPACE
PIPELINE_TEMPLATE_NAMESPACE = 'window.Template'
Template extension¶
Templates are detected by their extension, by default .jst, but you can use your own extension via PIPELINE_TEMPLATE_EXT
PIPELINE_TEMPLATE_EXT = '.mustache'
Template separator¶
Templates identifier are built using a replacement for directory separator, by default _, but you specify your own sperator via PIPELINE_TEMPLATE_SEPARATOR
PIPELINE_TEMPLATE_SEPARATOR = '/'
Using it with your favorite template library¶
Mustache¶
To use it with Mustache you will need some extra javascript
Mustache.template = function(templateString) {
return function() {
if (arguments.length < 1) {
return templateString;
} else {
return Mustache.to_html(templateString, arguments[0], arguments[1]);
}
};
};
And use these settings
PIPELINE_TEMPLATE_EXT = '.mustache'
PIPELINE_TEMPLATE_FUNC = 'Mustache.template'
Handlebars¶
To use it with Handlebars, use the following settings
PIPELINE_TEMPLATE_EXT = '.handlebars'
PIPELINE_TEMPLATE_FUNC = 'Handlebars.compile'
PIPELINE_TEMPLATE_NAMESPACE = 'Handlebars.templates'