diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4eac2c2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.idea +nbproject \ No newline at end of file diff --git a/doT.min.js b/doT.min.js new file mode 100644 index 0000000..be40f0d --- /dev/null +++ b/doT.min.js @@ -0,0 +1,7 @@ +// Laura Doktorova https://github.com/olado/doT +(function(){function o(){var b={"&":"&","<":"<",">":">",'"':""","'":"'","/":"/"},a=/&(?!\\w+;)|<|>|"|'|\//g;return function(f){return f?f.toString().replace(a,function(g){return b[g]||g}):f}}function p(b,a,f){return(typeof a==="string"?a:a.toString()).replace(b.define||h,function(g,e,c,i){if(e.indexOf("def.")===0)e=e.substring(4);if(!(e in f))if(c===":")f[e]=i;else eval("def['"+e+"']="+i);return""}).replace(b.use||h,function(g,e){var c=eval(e);return c?p(b,c,f):c})}function l(b){return b.replace(/\\('|\\)/g, +"$1").replace(/[\r\t\n]/g," ")}var j={version:"0.2.0",templateSettings:{evaluate:/\{\{([\s\S]+?)\}\}/g,interpolate:/\{\{=([\s\S]+?)\}\}/g,encode:/\{\{!([\s\S]+?)\}\}/g,use:/\{\{#([\s\S]+?)\}\}/g,define:/\{\{##\s*([\w\.$]+)\s*(\:|=)([\s\S]+?)#\}\}/g,conditional:/\{\{\?(\?)?\s*([\s\S]*?)\s*\}\}/g,iterate:/\{\{~\s*(?:\}\}|([\s\S]+?)\s*\:\s*([\w$]+)\s*(?:\:\s*([\w$]+))?\s*\}\})/g,varname:"it",strip:true,append:true,selfcontained:false},template:undefined,compile:undefined},m=function(){return this||(0,eval)("this")}(); +if(typeof module!=="undefined"&&module.exports)module.exports=j;else if(typeof define==="function"&&define.amd)define(function(){return j});else m.doT=j;m.encodeHTML=o();var q={append:{start:"'+(",end:")+'",startencode:"'+encodeHTML("},split:{start:"';out+=(",end:");out+='",startencode:"';out+=encodeHTML("}},h=/$^/;j.template=function(b,a,f){a=a||j.templateSettings;var g=a.append?q.append:q.split,e,c=0,i;if(a.use||a.define){var r=m.def;m.def=f||{};b=p(a,b,m.def);m.def=r}b=("var out='"+(a.strip?b.replace(/(^|\r|\n)\t* +| +\t*(\r|\n|$)/g, +" ").replace(/\r|\n|\t|\/\*[\s\S]*?\*\//g,""):b).replace(/'|\\/g,"\\$&").replace(a.interpolate||h,function(n,d){return g.start+l(d)+g.end}).replace(a.encode||h,function(n,d){e=true;return g.startencode+l(d)+g.end}).replace(a.conditional||h,function(n,d,k){return d?k?"';}else if("+l(k)+"){out+='":"';}else{out+='":k?"';if("+l(k)+"){out+='":"';}out+='"}).replace(a.iterate||h,function(n,d,k,s){if(!d)return"';} } out+='";c+=1;i=s||"i"+c;d=l(d);return"';var arr"+c+"="+d+";if(arr"+c+"){var "+k+","+i+"=-1,l"+ +c+"=arr"+c+".length-1;while("+i+" - + + - + Templating Test Suite - - - - + + + + diff --git a/doT/index.html b/doT/index.html index d65a84b..0dc4260 100644 --- a/doT/index.html +++ b/doT/index.html @@ -1,209 +1,9 @@ - + - - - - + + -Form me on GitHub - -

doT.js

-

The fastest + concise javascript template engine
for Node.js and browsers.

- -

Origins

-

-doT.js was created in search of the fastest and concise JavaScript templating function with emphasis on performance under V8 and Node.js. -It shows great performance for both Node.js and browsers. -
-

-During my quest I found 2 template engines that caught my attention and inspired doT. -
The first one was jQote2, a jQuery plugin, it was the first engine to break the speeds by using string concatenation and avoiding 'with' statements. -
The second one was underscore.js which had a nicely designed extension friendly templating function. -

-doT.js is fast, small and has no dependencies. -

-

-

- -

Source

-github.com/olado/doT -

by Laura Doktorova, MIT license

- -

Features

- - -

Usage play with it, edit and see results as you type

-
- -
- - -
-
-
-

Template

- -
-

Compile-time defines (def)

- -
-
-
-

doT.template compiles it into

-
-
-
-
-
-

Data

- -
-
-

Result

-
-
-
-
-
-

Compile time evaluation vs Runtime evaluation

-You can improve performance further if you use compile time evaluation. It is useful in cases when the data that you want to use are not changing with each run of the template. Think of it as defines or constant variables. -

It is also used to statically compile partials. This comes in handy when you want to include similar header and footer on multiple pages. doT also allows to customize partial right from the template that will include it.

Check advanced sample and one more sample for hints on how to use defines and partials. - -

Benchmarks

-

-Here is the first benchmark of doT in jsperf.
-Here is a more recent benchmark against the new and upgraded engines that popped up lately. -
-People are constantly adding new javascript template engine benchmarks. -

-Additional benchmarks are available in github -
-

-To run the benchmarks for measuring execution of compiled templates: -
-In the browser: navigate to benchmarks/index.html or go here -
-With node: node benchmarks/templatesBench.js -

-

-To run the benchmarks for measuring compilation speed: -
In the browser: navigate to benchmarks/genspeed.html -
-With node: node benchmarks/compileBench.js -

- -

Installation

-

For Node.js

-

If you plan to use doT with Node.js, you can install doT with npm: -

> npm install dot

-Then use require('dot') in your code. -

-

For browsers

-Include the javascript file in your source: -

<script type="text/javascript" src="doT.js"></script>

- -

Sample

-
// 1. Compile template function
-var tempFn = doT.template("<h1>Here is a sample template {{=it.foo}}</h1>"); -
// 2. Use template function as many times as you like
-var resultText = tempFn({foo: 'with doT'}); - -

API

-

doT.templateSettings - default compilation settings

-You can customize doT by changing compilation settings. Here are the default settings: -
doT.templateSettings = {
-  evaluate:    /\{\{([\s\S]+?)\}\}/g,
-  interpolate: /\{\{=([\s\S]+?)\}\}/g,
-  encode:      /\{\{!([\s\S]+?)\}\}/g,
-  use:         /\{\{#([\s\S]+?)\}\}/g,
-  define:      /\{\{##\s*([\w\.$]+)\s*(\:|=)([\s\S]+?)#\}\}/g,
-  conditional: /\{\{\?(\?)?\s*([\s\S]*?)\s*\}\}/g,
-  iterate:     /\{\{~\s*(?:\}\}|([\s\S]+?)\s*\:\s*([\w$]+)\s*(?:\:\s*([\w$]+))?\s*\}\})/g,
-  varname: 'it',
-  strip: true,
-  append: true,
-  selfcontained: false
-};
-
 -If you want to use your own delimiters, you can modify RegEx in doT.templateSettings to your liking. -

Here is the list of default delimiters:

- - -- - - - - - - - - -
{{ }}for evaluation
{{= }}for interpolation
{{! }}for interpolation with encoding
{{# }}for compile-time evaluation/includes and partials
{{## #}}for compile-time defines
{{? }}for conditionals
{{~ }}for array iteration
- -

-By default, the data in the template must be referenced with 'it'. To change the default variable name, modify setting 'varname'. For example, if you set 'varname' to "foo, bar" you will be able to pass 2 data instances and refer to them from the template by foo and bar.

-

-To control whitespace use 'strip' option, true - to strip, false - to preserve. -

-

-'append' is a performance optimization setting. It allows to tweak performance, depending on the javascript engine used and size of the template, it may produce better results with append set to false. -

-

-If 'selfcontained' is true, doT will produce functions that have no dependencies on doT. In general, generated functions have no dependencies on doT, with the exception for encodeHTML and it is only added if encoding is used. If 'selfcontained' is true and template needs encoding, encodeHTML function will be included in the generated template function. -

- -

doT.template - template compilation function

-

Call this function to compile your template into a function.

- function(tmpl, c, def) - -By default, the produced function expects one parameter - data - with the name 'it'. The names and number of parameters can be changed by changing doT.templateSettings.varname

- -

Issues

-github.com/olado/doT/issues - -

History

-First released on January 10, 2011 -
Latest version: 0.2.0 April 29, 2012 - -

Author

-@olado - -
doT.js is an open source component of bebedo.com, MIT license
- - - - - - - + \ No newline at end of file diff --git a/doT/tutorial.html b/doT/tutorial.html index 4773e59..7a8eeb3 100644 --- a/doT/tutorial.html +++ b/doT/tutorial.html @@ -1,6 +1,7 @@ - + + doT.js - Tutorial for the fastest + concise javascript template engine @@ -311,7 +312,7 @@

Fork doT.js on github

- +