Add docs drafts

This commit is contained in:
bzick
2013-02-09 10:59:08 +04:00
parent 79fd0a199c
commit e15df61267
8 changed files with 111 additions and 33 deletions

23
docs/mods/date_format.md Normal file
View File

@@ -0,0 +1,23 @@
Modifier |date_format
=====================
**draft**
Модификатор позволят вывести дату в произвольном формате, согласно форматированию [strftime()](http://docs.php.net/strftime).
Модификатор принимает timestamp или строку, которую можно преобразовать через [strtotime()](http://docs.php.net/strtotime).
Формат по умолчанию: `%b %e, %Y`.
**[Допустимые квантификаторы формата](http://docs.php.net/strftime#refsect1-function.strftime-parameters)**
```smarty
{var $ts = time()}
{$ts|date_format:"%Y/%m/%d %H:%M:%s"} output like 2013/02/08 21:01:43
{$ts|date_format:"-1 day"} output like 2013/02/07 21:01:43
{var $date = "2008-12-08"}
{$ts|date_format:"%Y/%m/%d %H:%M:%s"} output like 2008/12/08 00:00:00
```

13
docs/mods/lower.md Normal file
View File

@@ -0,0 +1,13 @@
Modifier |lower
===============
Modifier is used to lowercase a variable or string. Have short alias `low`
This is equivalent to the PHP [strtolower()](http://docs.php.net/lower) function.
```smarty
{var $name = "Bzick"}
{$name} output Bzick
{$name|upper} output bzick
{$name|up} output bzick too
```

22
docs/mods/truncate.md Normal file
View File

@@ -0,0 +1,22 @@
Modifier |truncate
==================
**draft**
Обрезает строку до указанной длины. Может обрезать как ровно по символу так и завершивемогуся слову, где итоговоя строка не привыет указанной длины.
```smarty
{$long_string|truncate:$length:$etc:$break_words:$middle}
```
* `$length` обязательный параметр, указывающий максимальную длину выводимой сроки
* `$etc`, по умолчанию `...`, содержащий строку которой будет заменены "лишние" символы.
* `$break_word`, по умолчанию **FALSE**. Включенный флаг, который указывает модификатору не разбивать слово, а найти ближайший пробельный символ, после которого строка буде обрезана
* `$middle`, по умочанию **FALSE**. Включенный флаг, который указывает, что "лишние" данные нужно вырезать из середины строки, а не из конца.
```smarty
{var $str = "very very long string"}
{$str|truncate:10:" read more..."} output: very very read more...
{$str|truncate:5:" ... ":true:true} output: very ... string
```

View File

@@ -1,3 +1,13 @@
Modifier |upper
===============
Modifier is used to uppercase a variable or string. Have short alias `up`
This is equivalent to the PHP [strtoupper()](http://docs.php.net/strtoupper) function.
```smarty
{var $name = "Bzick"}
{$name} output Bzick
{$name|upper} output BZICK
{$name|up} output BZICK too
```