From a7ec41b3febbbe53c44139429fcd51fc419c8415 Mon Sep 17 00:00:00 2001 From: didou Date: Sun, 28 Mar 2004 16:48:54 +0000 Subject: [PATCH] clean two files --- docs/en/designers/language-basic-syntax.xml | 117 +++-- docs/en/designers/language-variables.xml | 466 +++++++++++--------- 2 files changed, 332 insertions(+), 251 deletions(-) diff --git a/docs/en/designers/language-basic-syntax.xml b/docs/en/designers/language-basic-syntax.xml index 0cbd54e0..3e813810 100644 --- a/docs/en/designers/language-basic-syntax.xml +++ b/docs/en/designers/language-basic-syntax.xml @@ -26,6 +26,7 @@ Comments + {html_options values=$vals selected=$selected output=$output} -</SELECT> + +]]> + @@ -99,6 +102,7 @@ function attribute syntax + {html_options values=$vals selected=$selected output=$output} -</SELECT> - - + +]]> + + + Embedding Vars in Double Quotes - Smarty will recognize assigned variables embedded in double quotes so long - as the variables contain only numbers, letters, underscores and brackets - []. With any other characters (period, object reference, etc.) the variable - must be surrounded by backticks. + Smarty will recognize assigned variables embedded in double quotes so long + as the variables contain only numbers, letters, underscores and brackets + []. With any other characters (period, object reference, etc.) the variable + must be surrounded by backticks. embedded quotes syntax + - - +{include file="subdir/$tpl_name.tpl"} <-- will replace $tpl_name with value +{cycle values="one,two,`$smarty.config.myval`"} <-- must have backticks +]]> + + + Math - Math can be applied directly to variable values. + Math can be applied directly to variable values. math examples +bar-$bar[1]*$baz->foo->bar()-3*7} {if ($foo+$bar.test%$baz*134232+10+$b+10)} {$foo|truncate:"`$fooTruncCount/$barTruncFactor-1`"} -{assign var="foo" value="`$foo+$bar`"} - - +{assign var="foo" value="`$foo+$bar`"} +]]> + + + Escaping Smarty Parsing - It is sometimes desirable or even necessary to have Smarty ignore sections it - would otherwise parse. A classic example is embedding Javascript or CSS code in + It is sometimes desirable or even necessary to have Smarty ignore sections it + would otherwise parse. A classic example is embedding Javascript or CSS code in a template. The problem arises as those languages use the { and } characters which are also the default delimiters for Smarty. - The simplest thing is to avoid the situation altogether by separating your Javascript - and CSS code into their own files and then using standard HTML methods to access them. - - - Including literal content is possible using {literal} .. {/literal} blocks. - Similar to HTML entity usage, you can use {ldelim} and {rdelim} - to display the current delimiters. + The simplest thing is to avoid the situation altogether by separating your Javascript + and CSS code into their own files and then using standard HTML methods to access them. - It is often convenient to simply change Smarty's $left_delimiter and - $right_delimiter. + Including literal content is possible using {literal} .. {/literal} blocks. + Similar to HTML entity usage, you can use {ldelim} and {rdelim} to display the current delimiters. + + + + It is often convenient to simply change Smarty's $left_delimiter and + $right_delimiter. changing delimiters example - + +left_delimiter = '<!--{'; -$smarty->right_delimiter = '}-->'; +$smarty->left_delimiter = ''; $smarty->assign('foo', 'bar'); $smarty->display('example.tpl'); +?> + --- example.tpl -<script language="javascript"> -var foo = <!--{$foo}-->; + +]]> + + + + \ No newline at end of file +--> diff --git a/docs/en/designers/language-variables.xml b/docs/en/designers/language-variables.xml index 162ceb58..b37eb47a 100644 --- a/docs/en/designers/language-variables.xml +++ b/docs/en/designers/language-variables.xml @@ -3,8 +3,8 @@ Variables - Smarty has several different types of variables. The type of the variable - depends on what symbol it is prefixed with (or enclosed within). + Smarty has several different types of variables. The type of the variable + depends on what symbol it is prefixed with (or enclosed within). @@ -13,128 +13,169 @@ etc. To print a variable, simply enclose it in the delimiters so that it is the only thing contained between them. Examples: + + +]]> + Variables assigned from PHP - Variables that are assigned from PHP are referenced by preceding them with - a dollar sign $. Variables assigned from within the - template with the assign - function are also displayed this way. + Variables that are assigned from PHP are referenced by preceding them with + a dollar sign $. Variables assigned from within the + template with the assign + function are also displayed this way. assigned variables - + + Your last login was on {$lastLoginDate}. - -OUTPUT: - +]]> + + + This will output: + + + - +
+Your last login was on January 11th, 2001. +]]> + + Associative arrays - You can also reference associative array variables that are - assigned from PHP by specifying the key after the '.' (period) - symbol. + You can also reference associative array variables that are + assigned from PHP by specifying the key after the '.' (period) + symbol. - -accessing associative array variables - -index.php: - + + accessing associative array variables + +assign('Contacts', array('fax' => '555-222-9876', 'email' => 'zaphod@slartibartfast.com', 'phone' => array('home' => '555-444-3333', 'cell' => '555-111-1234'))); -$smarty->display('index.tpl'); - -index.tpl: - -{$Contacts.fax}<br> -{$Contacts.email}<br> +$smarty->display('index.tpl'); +?> +]]> + + + where the content of index.tpl is: + + + +{$Contacts.email}
{* you can print arrays of arrays as well *} -{$Contacts.phone.home}<br> -{$Contacts.phone.cell}<br> - -OUTPUT: - -555-222-9876<br> -zaphod@slartibartfast.com<br> -555-444-3333<br> -555-111-1234<br> - +{$Contacts.phone.home}
+{$Contacts.phone.cell}
+]]> + + + this will output: + + + +zaphod@slartibartfast.com
+555-444-3333
+555-111-1234
+]]> + + - + Array indexes - You can reference arrays by their index, much like native PHP - syntax. + You can reference arrays by their index, much like native PHP + syntax. - -accessing arrays by index - -index.php: + + accessing arrays by index + +assign('Contacts', array('555-222-9876', 'zaphod@slartibartfast.com', array('555-444-3333', '555-111-1234'))); -$smarty->display('index.tpl'); +$smarty->display('index.tpl'); -index.tpl: - -{$Contacts[0]}<br> -{$Contacts[1]}<br> +?> +]]> + + + where index.tpl is: + + + +{$Contacts[1]}
{* you can print arrays of arrays as well *} -{$Contacts[2][0]}<br> -{$Contacts[2][1]}<br> +{$Contacts[2][0]}
+{$Contacts[2][1]}
+]]> + + + This will output: + + + +zaphod@slartibartfast.com
+555-444-3333
+555-111-1234
+]]> + + + + + Objects + + Properties of objects assigned from PHP can be referenced + by specifying the property name after the '->' symbol. + + + accessing object properties + + +email: {$person->email}
+]]> + + + this will output: + + + +email: zaphod@slartibartfast.com
+]]> + + + + -OUTPUT: - -555-222-9876<br> -zaphod@slartibartfast.com<br> -555-444-3333<br> -555-111-1234<br> - - - - Objects - - Properties of objects assigned from PHP can be referenced - by specifying the property name after the '->' symbol. - - -accessing object properties - -name: {$person->name}<br> -email: {$person->email}<br> - -OUTPUT: - -name: Zaphod Beeblebrox<br> -email: zaphod@slartibartfast.com<br> - - - - - + Variables loaded from config files Variables that are loaded from the config files are referenced by @@ -144,92 +185,105 @@ email: zaphod@slartibartfast.com<br> The second syntax is useful for embedding into quoted attribute values. - - -config variables - -foo.conf: - + + config variables + + foo.conf: + + + + + + index.tpl: + + + +{#pageTitle#} + + + + + + + +
FirstLastAddress
+ + +]]> + + + index.tpl: (alternate syntax) + + + - + +{$smarty.config.pageTitle} + + + + + + + +
FirstLastAddress
+ + +]]> + + + this will output for both examples: + + + +This is mine + + + + + + + +
FirstLastAddress
+ + +]]> + + - Config file variables cannot be used until - after they are loaded in from a config file. This procedure is - explained later in this document under - config_load. + Config file variables cannot be used until + after they are loaded in from a config file. This procedure is + explained later in this document under config_load. - - {$smarty} reserved variable - - The reserved {$smarty} variable can be used to access several - special template variables. The full list of them follows. - + + {$smarty} reserved variable + + The reserved {$smarty} variable can be used to access several + special template variables. The full list of them follows. + - - Request variables - - The request variables such as get, post, cookies, server, - environment, and session variables can be accessed as demonstrated - in the examples below: - - - - displaying request variables - + + Request variables + + The request variables such as get, post, cookies, server, + environment, and session variables can be accessed as demonstrated + in the examples below: + + + displaying request variables + + - - - Note: For historical reasons {$SCRIPT_NAME} can be accessed - directly though {$smarty.server.SCRIPT_NAME} is the - proposed way to access this value. - +{$smarty.request.username} +]]> + + + + + For historical reasons {$SCRIPT_NAME} can be accessed + directly though {$smarty.server.SCRIPT_NAME} is the + proposed way to access this value. + + + - - - + {$smarty.now} - The current timestamp can be accessed with {$smarty.now}. The - number reflects the number of seconds passed since the so-called - Epoch (January 1, 1970) and can be passed directly to - date_format modifier for display purposes. + The current timestamp can be accessed with {$smarty.now}. The + number reflects the number of seconds passed since the so-called + Epoch (January 1, 1970) and can be passed directly to + date_format modifier for display purposes. - - -using {$smarty.now} - + + using {$smarty.now} + + - +{$smarty.now|date_format:"%Y-%m-%d %H:%M:%S"} +]]> + + - + {$smarty.const} - You can access PHP constant values directly. + You can access PHP constant values directly. - - -using {$smarty.const} - -{$smarty.const._MY_CONST_VAL} - + + using {$smarty.const} + + + + {$smarty.capture} - The output captured via {capture}..{/capture} construct can be - accessed using {$smarty} variable. See section on - capture for an example. + The output captured via {capture}..{/capture} construct can be + accessed using {$smarty} variable. See section on + capture for an example. {$smarty.config} - {$smarty} variable can be used to refer to loaded config variables. - {$smarty.config.foo} is a synonym for {#foo#}. See the section on - config_load for an example. + {$smarty} variable can be used to refer to loaded config variables. + {$smarty.config.foo} is a synonym for {#foo#}. See the section on + config_load for an example. - + {$smarty.section}, {$smarty.foreach} - {$smarty} variable can be used to refer to 'section' and - 'foreach' loop properties. See docs for - section and - foreach. + {$smarty} variable can be used to refer to 'section' and + 'foreach' loop properties. See docs for + section and + foreach. {$smarty.template} - This variable contains the name of the current template being - processed. + This variable contains the name of the current template being + processed. {$smarty.version} - This variable contains the version of Smarty the template was compiled with. + This variable contains the version of Smarty the template was compiled with. - + + \ No newline at end of file +-->