Add docs (drafts)

This commit is contained in:
bzick 2013-02-13 18:51:53 +04:00
parent 3658bd0c93
commit b713985c5e
13 changed files with 64 additions and 1 deletions

3
docs/callbacks.md Normal file
View File

@ -0,0 +1,3 @@
Callbacks
=========

3
docs/ext/parsing.md Normal file
View File

@ -0,0 +1,3 @@
Parsing templates
=================

3
docs/ext/provider.md Normal file
View File

@ -0,0 +1,3 @@
Add template provider
=====================

19
docs/install.md Normal file
View File

@ -0,0 +1,19 @@
Requirements and installation
=============================
Для установки через composer тебуется указать в `composer.json` вашего проекта
```json
{
"require": {
"bzick/aspect": "0.9.*"
},
"repositories": [
{
"type": "git",
"url": "https://github.com/bzick/aspect.git"
}]
}
```
Для работы шаблонизатора потребуется расширение tokenizer. Для загрузки классов используется `psr-0` формат.

View File

@ -32,7 +32,6 @@ Conversation about [tags](./tags.md)
* [if](./tags/if.md), `elseif` and `else`
* [foreach](./tags/foreach.md), `foreaelse`, `break` and `continue`
* [for](./tags/for.md), `forelse`, `break` and `continue`
* [while](./tags/while.md), `break` and `continue`
* [switch](./tags/switch.md), `case`, `default` and `break`
* [cycle](./tags/cycle.md)
* [include](./tags/include.md)

8
docs/mods/escape.md Normal file
View File

@ -0,0 +1,8 @@
Modifier |escape
================
Используется для кодирования / экранирования спецсимволов по алгоритмам экранирования HTML, URL'ов. По умолчанию активирован режим экранирования HTML.
```smarty
{$html_data|escape:'HTML'}
```

3
docs/mods/strip.md Normal file
View File

@ -0,0 +1,3 @@
Modifier |strip
===============

3
docs/mods/unescape.md Normal file
View File

@ -0,0 +1,3 @@
Modifier |unescape
==================

3
docs/tags/capture.md Normal file
View File

@ -0,0 +1,3 @@
Tag {capture}
=============

3
docs/tags/cycle.md Normal file
View File

@ -0,0 +1,3 @@
Tag {cycle}
===========

3
docs/tags/extens.md Normal file
View File

@ -0,0 +1,3 @@
Tag {extends}
=============

10
docs/tags/filter.md Normal file
View File

@ -0,0 +1,10 @@
Tags {filter}
=============
Позволяет применить модификаторы на фрагмент шаблона
```smarty
{filter|strip_tags|truncate:80}
Remove all HTML <b>tags</b> and truncate text to 80 symbols
{/filter}
```

3
docs/tags/switch.md Normal file
View File

@ -0,0 +1,3 @@
Tag {switch}
============