From fc9f195e8e10269a8f6ea2e201597c4f00f057cf Mon Sep 17 00:00:00 2001 From: bzick Date: Sun, 24 Feb 2013 14:02:18 +0400 Subject: [PATCH] Update docs --- README.md | 6 ++---- docs/syntax.md | 51 +++++++++++++++++++++++--------------------------- 2 files changed, 25 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 3bda542..7e5d99d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ Aspect PHP Template Engine ========================== -> Composer package: `"bzick/aspect": "dev-master"`. [How to install](./docs/install.md). -> -> Build status: [![Build Status](https://travis-ci.org/bzick/aspect.png?branch=master)](https://travis-ci.org/bzick/aspect) +> Composer package: `{"bzick/aspect": "dev-master"}` [![Build Status](https://travis-ci.org/bzick/aspect.png?branch=master)](https://travis-ci.org/bzick/aspect) -## [About](./docs/about.md) :: [Documentation](./docs/main.md) :: [Benchmark](./docs/benchmark.md) :: [Bugs](https://github.com/bzick/aspect/issues) :: [Articles](./docs/articles.md) +## [About](./docs/about.md) :: [Documentation](./docs/main.md) :: [Benchmark](./docs/benchmark.md) :: [Articles](./docs/articles.md) Primitive template diff --git a/docs/syntax.md b/docs/syntax.md index dc45be3..e4bf9f5 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -1,9 +1,7 @@ -Синтаксис -========= +Syntax +====== -### Переменные - -Вывод значений переменных в шаблонизаторе Aspect идентичен правилам вывода шаблонизатора Smarty +### Output variables ```smarty {$foo} @@ -21,7 +19,7 @@ {$foo->bar()} ``` -Комбинированные варианты +complex variables ```smarty {$foo.bar.baz} @@ -29,11 +27,10 @@ {$foo[4].baz} {$foo[4].$baz} {$foo.bar.baz[4]} -{$foo->bar($baz, 2, $bar)} -{"foo"} +{$foo[ $bar.baz ]} ``` -### Математические операции +Operations ```smarty {$x+$y} @@ -43,15 +40,13 @@ [Список всех операторов](./operators.md) -### Объявление переменных +Define variable ```smarty {var $foo = "bar"} {var $foo = 5} ``` -в качестве значения так же допускаются математические, логические операции и результаты функций - ```smarty {var $foo = $x + $y} {var $foo = $x.y[z] + $y} @@ -60,34 +55,34 @@ {var $foo.bar.baz = 1} ``` -Подробнее смотрите [{var}](./tags/var.md) +See also [{var}](./tags/var.md) documentation. -#### Объявление массивов +Define arrays ```smarty -{var $foo=[1,2,3]} -{var $foo=['y'=>'yellow','b'=>'blue']} can be associative -{var $foo=[1,[9,8],3]} can be nested +{var $foo = [1,2,3]} +{var $foo = ['y'=>'yellow','b'=>'blue']} can be associative +{var $foo = [1,[9,8],3]} can be nested ``` -в качестве ключа и значения так же допускаются математические, логические операции и результаты функций +more complex example ```smarty -{var $foo=[$a, $d.c, $a + $f]} -{var $foo=['y'=>'yellow', $color=>$colors[ $color ]} can be associative -{var $foo=[1,[$parent ,$a + $e],3]} can be nested +{var $foo = [$a, $d.c, $a + $f]} +{var $foo = ['y'=>'yellow', $color=>$colors[ $color ]} +{var $foo = [1,[$parent ,$a + $e],3]} ``` -### Работа с объектами +### Objects ```smarty {$object->method1($x)->method2($y)} {var $foo=$object->item->method($y, 'named')} ``` -Вызов метода в шаблоне можно запретить [настройками](./settings.md) +See also [security options](./settings.md) -### Работа со скалярными значениями +### Scalar values Строки в Aspect обрабатываются идентично правилам подстановки переменных в строки в PHP, т.е. в двойных кавычках переменная заменяется на её значение, в одинарных замены не происходит. @@ -121,7 +116,7 @@ {var $magick = 5381|calc} ``` -### Модификаторы +### Modificatiors * Модификаторы позволяют изменить значение переменной перед выводом или использованием в выражении * Модификаторы записываются после переменной через символ вертикальной черты "|" @@ -143,7 +138,7 @@ [Список модификаторов](./main.md#modifiers) -### Теги +### Tags Каждый тэг шаблонизатора либо выводит переменную, либо вызывает какую-либо функцию. (переписать) Тег вызова функции начинается с названия функции и содержит список аргументов: @@ -188,7 +183,7 @@ {funct arg=($a.d.c|count+4)/3} ``` -### Игнорирование разделителя +### Ignoring temaplate code В шаблонизаторе Aspect используются фигурные скобки для отделения HTML от кода Aspect. Если требуется вывести текст, содержащий фигурные скобки помните о следующих возможностях: @@ -228,7 +223,7 @@ ``` -### Пробелы и переносы строк +### Whitespaces Шаблонизатор допускает любое количество пробелов или переносов строк в своём коде