From 281757b902465c109826be02836dcbb0e3450c7f Mon Sep 17 00:00:00 2001 From: bzick Date: Mon, 18 Mar 2013 10:45:07 +0400 Subject: [PATCH] Add documentation for length modifier Fix documentation for truncate modifier --- docs/mods/length.md | 8 ++++++++ docs/mods/truncate.md | 8 +++++--- 2 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 docs/mods/length.md diff --git a/docs/mods/length.md b/docs/mods/length.md new file mode 100644 index 0000000..62e8408 --- /dev/null +++ b/docs/mods/length.md @@ -0,0 +1,8 @@ +Modifier length [RU] +==================== + +Модификатор возвращает длину значения переменной + +* если массив - длина массива +* если итератор - длина итератора +* если строка - длина строки (поддерживается UTF8 и не требует `mbstring`) \ No newline at end of file diff --git a/docs/mods/truncate.md b/docs/mods/truncate.md index be227da..cfbc6ec 100644 --- a/docs/mods/truncate.md +++ b/docs/mods/truncate.md @@ -4,12 +4,12 @@ Modifier truncate [RU] Обрезает строку до указанной длины. Может обрезать как ровно по символу так и завершивемогуся слову, где итоговоя строка не привыет указанной длины. ```smarty -{$long_string|truncate:$length:$etc:$break_words:$middle} +{$long_string|truncate:$length:$etc:$by_words:$middle} ``` * `$length` обязательный параметр, указывающий максимальную длину выводимой сроки * `$etc`, по умолчанию `...`, содержащий строку которой будет заменены "лишние" символы. -* `$break_word`, по умолчанию **FALSE**. Включенный флаг, который указывает модификатору не разбивать слово, а найти ближайший пробельный символ, после которого строка буде обрезана +* `$by_word`, по умолчанию **FALSE**. Флаг указывает модификатору не разбивать слово, а найти ближайший (в меньшую строну) пробельный символ, после которого строка буде обрезана * `$middle`, по умочанию **FALSE**. Включенный флаг, который указывает, что "лишние" данные нужно вырезать из середины строки, а не из конца. ```smarty @@ -17,4 +17,6 @@ Modifier truncate [RU] {$str|truncate:10:" read more..."} output: very very read more... {$str|truncate:5:" ... ":true:true} output: very ... string -``` \ No newline at end of file +``` + +Модификатор работает отлично с UTF8 и не требует расширения `mbstring` \ No newline at end of file