diff options
Diffstat (limited to 'vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md')
| -rw-r--r-- | vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md | 73 |
1 files changed, 39 insertions, 34 deletions
diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md index d0264dca3..9fa3540a3 100644 --- a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md +++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-indent.md @@ -1,62 +1,67 @@ -indent {#language.modifier.indent} -====== +# indent This indents a string on each line, default is 4. As an optional parameter, you can specify the number of characters to indent. As an optional second parameter, you can specify the character to use to -indent with eg use `"\t"` for a tab. +indent with. For example: use `"\t"` for a tab. - Parameter Position Type Required Default Description - -------------------- --------- ---------- ------------- --------------------------------------------------- - 1 integer No 4 This determines how many characters to indent to. - 2 string No (one space) This is the character used to indent with. +## Basic usage +```smarty +{$myVar|indent:4} +``` +## Parameters - <?php +| Parameter Position | Type | Required | Default | Description | +|--------------------|---------|----------|-------------|---------------------------------------------------| +| 1 | integer | No | 4 | This determines how many characters to indent to. | +| 2 | string | No | (one space) | This is the character used to indent with. | - $smarty->assign('articleTitle', - 'NJ judge to rule on nude beach. - Sun or rain expected today, dark tonight. - Statistics show that teen pregnancy drops off significantly after 25.' - ); - ?> +## Examples - +```php +<?php -Where template is: +$smarty->assign('articleTitle', + 'NJ judge to rule on nude beach. +Sun or rain expected today, dark tonight. +Statistics show that teen pregnancy drops off significantly after 25.' + ); +``` +Where template is: - {$articleTitle} - - {$articleTitle|indent} +```smarty +{$articleTitle} - {$articleTitle|indent:10} +{$articleTitle|indent} - {$articleTitle|indent:1:"\t"} +{$articleTitle|indent:10} +{$articleTitle|indent:1:"\t"} +``` - Will output: +``` +NJ judge to rule on nude beach. +Sun or rain expected today, dark tonight. +Statistics show that teen pregnancy drops off significantly after 25. NJ judge to rule on nude beach. Sun or rain expected today, dark tonight. Statistics show that teen pregnancy drops off significantly after 25. + NJ judge to rule on nude beach. + Sun or rain expected today, dark tonight. + Statistics show that teen pregnancy drops off significantly after 25. + NJ judge to rule on nude beach. Sun or rain expected today, dark tonight. Statistics show that teen pregnancy drops off significantly after 25. - - NJ judge to rule on nude beach. - Sun or rain expected today, dark tonight. - Statistics show that teen pregnancy drops off significantly after 25. - - NJ judge to rule on nude beach. - Sun or rain expected today, dark tonight. - Statistics show that teen pregnancy drops off significantly after 25. - +``` -See also [`strip`](#language.modifier.strip), -[`wordwrap`](#language.modifier.wordwrap) and -[`spacify`](#language.modifier.spacify). +See also [`strip`](language-modifier-strip.md), +[`wordwrap`](language-modifier-wordwrap.md) and +[`spacify`](language-modifier-spacify.md). |