# AsyncTpl (closed)

Is a asynchronous template engine for nodejs or the browser.


## Features

* [XML](#xml-syntax), [Smarty](#smarty) or custom syntaxis
* async/streaming operation
* [compile](#compile-errors) & [run-time](#run-time-errors) errors
* browser/nodejs compatibility
* [high performance](https://github.com/RubaXa/AsyncTpl/tree/master/benchmark)
* 10KB (minified + gzipped)


## Usage

### NodeJS

#### index.js
```js
var xtpl = require('./lib/AsyncTpl').engine('XML');

// Setup XML
xtpl.NS     = 'xtpl';   // namespace
xtpl.ASYNC  = true;     // async include templates
xtpl.STREAM = false;    // streaming
xtpl.ESCAPE = true;     // html escape all variables
xtpl.DEBUG  = true;     // compile & run-time errors (console.log)
xtpl.ROOT_DIR       = './tpl/';
xtpl.COMPILE_DIR    = './tpl_c/';

http.createServer(function (req, res){
	res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
	xtpl.fetch(
	  'index.xml'
	, {
		  text: 'Yahoo!'
		, items: [{ selected: true, href: '/', text: 'index' }, { href: '/page', text: 'page' }]
	}
	, function (result){
		res.end(result);
	});
}).listen(8082);
```

#### default.xml -- default page
```html


	
	
		
			
			
		
		
			


			

				
					default content
				
			

			
		
	

	
		
			
				
			
		
	

```

#### index.xml -- index page, based on default.xml
```html


	

	AsyncTpl :: XML

	

		

			
				item.text.toUpperCase()
			
		
	

	
		

			text:
			
			
		
		GO!
	

```

#### HTML result
```html



	
	

	

		

			
INDEX
			
PAGE
		
	
	

		
text: Yahoo!
		GO!
	
	


```


--------------------------


### Browser

```html



...



...




```

--------------------------


## Support XML

* [if](#if)
* [include](#include)
* [assign](#assign)
* [tag](#tag)
* [block](#block): `get & set`
* [choose](#choose): `when & otherwise`
* [foreach](#foreach): `iterate, as & index`
* [bind](#bind)
* [xtpl:attrs](#xattrs)
* [part](#part)
* [pull](#pull): `loading, fail & success`
* [script](#script)
* [text](#text)
* [value](#value)
* [comment](#comment)
* [attributes](#attributes)
* [closure](#closure)
* [doctype](#doctype)



### if
```html

	true

```
```html
true
```


### include
```html

```


### assign
```html


	
	
	
	

	url.protocol
	ctx.double.slashes
	url.hostname
	slash

```
```html
http://rubaxa.org/
```


### tag
```html


	
		

			
			

			
		
	

	
		
	

	
		
Email subscribe
		

			E-mail: 
		
	

```
```html

	
Email subscribe
	

		E-mail: 
	
	

	

```


### block
```js
var ctx = { items: [5,10] }
```
```html


	
	
		second
	

	1
	1.1

	
		attrs[0]+attrs[1]
	

	
	
	

	
		val
	
	

	

	
	
		result
	

```
```html
1.1 second 15-5=10
```


### choose
```html


	

		
			OK
			FAIL
			Hmmmm
		
	

```
```html
OK
```


### foreach
```js
ctx = { items: [1,2], colors: ['white', 'black'] };
```
```html

	
		idx
	
	

	
		val
	

	

		
			

				idx+1
				. 
				color
			
		
	

	

		
val
	

```
```html
123:12
1. white
2. black
2
8
```



### bind
```js
var collection = new Backbone.Collection([{ id: 1, val: 'item 1' }, { id: 2, val: 'item 2' }])

ctx = {
	list: collection
};

setTimeout(function (){
	collection.add({ id: 3, 'item 3' });
	setTimeout(function (){
		collection.get(2).set({ name: 'ITEM 2' }).save();
	}, 1000);
}, 1000);
```
```html

	

	
		

			
				

			
		
	

```



### node xtpl:attrs
```js
ctx = {
	  hasNav:	true
	, hasPrev:	false
	, hasNext:	true
};
```
```html

	

		
prev | next
		
nav:disabled
		

		

			
key. val
		
		
			val
		
	

```
```html

	
prev | next
	

		

			
a. 1
			
b. 2
		
	
	1234

```



### part
```js
ctx = { __part: 'first-part' };
```
```html

	second
	[
	
		-
	
	first
	]

```
```html
first-second
```



### pull
```js
ctx = {
	sync: function (next){ next(null, "OK"); },
	fail: function (next){ next("FAIL"); },
	async: function (next){
		loadText('http://site.org/get/text', function (res){
			next(null, res);
		});
	}
}
```
```html

	sync


	error


	...
	result

```
```html
OKFAIL...endHappy async text!
```



### script
```html




	ctx.script


	txt

```
```html
true
global
```


### text
```html
Hello
```
```html
Hello
```


### value
```html
ctx.value

```
```html
MyValue%username%
```



### comment
```html
comment
```
```html

```


### attributes
```js
ctx = {
	  href: 'http://site.org/link.html'
	, title: 'click me'
	, protocol: 'http:'
	, hostname: 'rubaxa.org'
}
```
```html
link.html


	
		
			ctx.protocol
			ctx.domain
			
		
		link
	
	test

index.html
```
```html
link.htmltest
```


### closure
```js
ctx = { first: 1, second: 2 };
```
```html

	a
	+
	b
	=
	a+b

```
```html
1+2=3
```



### doctype
```html
1. 
2. 
3. 
4. 
5. 
6. 
```
```html
1. 
2. 
3. 
4. 
5. 
6. 
```



### Compile errors
```html


    
	
        i
    

```
```html
Error: Tag "foreach", attribute "iterate" is missing in /my/template.xml on line 4
```



### Run-time errors
```html


	
	    
	

```
```html
Error: variable is not defined in /my/template.xml on line 3
```


### Custom tags (draft)
```js
var xtpl = AsyncTpl.engine('XML').tags({
				'menu': function (node){ return node.__close ? '' : '
'; }
			  , 'item': function (node, attrs){ return node.__close ? '' : ['
'].concat(this._build('a', attrs)); }
		});
```
```html

	0
	1

```
```html
0
1
```


----------------------------------------------------



## Support Smarty

* comment: `{{* ... *}}`
* foreach: `foreach, foreachelse`
* if statement: `if, elseif and else`
* modifilers: `upper, lower, capitalize, nl2br, regex_replace, combining`
* functions: `assign`
* `include` (support only file-attr)
* `extends + block`


### Usage

```js
var smarty = require('AsyncTpl').engine('Smarty');

smarty.LEFT = '{{';
smarty.RIGHT = '}}';

smarty
	// Add custom functions
	.fn({
		funcName: function (attrs, ctx){
			return attrs['a']+attrs['b'];
		}
	})

	// Add custom modifiers
	.modifiers({
		modName: function (val, arg1, arg2){
			reutrn val.substr(arg1, arg2);
		}
	})
;


smarty.fetch('my.tpl', {}, function (res){  });
```