diff --git a/docs/en/programmers/api-variables/variable-autoload-filters.xml b/docs/en/programmers/api-variables/variable-autoload-filters.xml index ad896cf9..fae14147 100644 --- a/docs/en/programmers/api-variables/variable-autoload-filters.xml +++ b/docs/en/programmers/api-variables/variable-autoload-filters.xml @@ -22,11 +22,11 @@ $smarty->autoload_filters = array('pre' => array('trim', 'stamp'), See also - register_outputfilter(), - register_prefilter(), - register_postfilter() + register_outputfilter(), + register_prefilter(), + register_postfilter() and - load_filter() + load_filter() diff --git a/docs/en/programmers/api-variables/variable-cache-dir.xml b/docs/en/programmers/api-variables/variable-cache-dir.xml index 8e941e50..f86590ea 100644 --- a/docs/en/programmers/api-variables/variable-cache-dir.xml +++ b/docs/en/programmers/api-variables/variable-cache-dir.xml @@ -5,19 +5,21 @@ This is the name of the directory where template caches are stored. By default this is - "./cache", meaning that - Smarty will look for the cache directory in the same directory - as the executing php script. + ./cache, meaning that + Smarty will look for the cache/ directory + in the same directory as the executing php script. This directory must - be writeable by the web server - (see install). + be writeable by the web server, + see install for more info. + + You can also use your own custom cache handler function to control cache files, which will ignore this setting. See also - $use_sub_dirs. + $use_sub_dirs. Technical Note @@ -36,13 +38,13 @@ See also - $caching, - $use_sub_dirs, - $cache_lifetime, - $cache_handler_func, - $cache_modified_check - and - Caching section. + $caching, + $use_sub_dirs, + $cache_lifetime, + $cache_handler_func, + $cache_modified_check + and the + caching section. diff --git a/docs/en/programmers/api-variables/variable-cache-handler-func.xml b/docs/en/programmers/api-variables/variable-cache-handler-func.xml index 37cfabd1..fc547673 100644 --- a/docs/en/programmers/api-variables/variable-cache-handler-func.xml +++ b/docs/en/programmers/api-variables/variable-cache-handler-func.xml @@ -5,9 +5,9 @@ You can supply a custom function to handle cache files instead of using the built-in method using the - $cache_dir. See the - custom cache - handler function section for details. + $cache_dir. + See the custom cache + handler function section for more details. diff --git a/docs/en/programmers/api-variables/variable-cache-lifetime.xml b/docs/en/programmers/api-variables/variable-cache-lifetime.xml index 493603a5..72362708 100644 --- a/docs/en/programmers/api-variables/variable-cache-lifetime.xml +++ b/docs/en/programmers/api-variables/variable-cache-lifetime.xml @@ -4,31 +4,45 @@ $cache_lifetime This is the length of time in seconds that a template cache is valid. - Once this time has expired, the cache will be regenerated. $caching must - be turned on (either 1 or 2) for $cache_lifetime to have any purpose. A - value of -1 will force the cache to never expire. A value of 0 will cause + Once this time has expired, the cache will be regenerated. + + + + + $caching must be turned on (either 1 or 2) for + $cache_lifetime to have any purpose. + + + + A value of -1 will force the cache to never expire. + + + A value of 0 will cause the cache to always regenerate (good for testing only, to disable caching a more efficient method is to set $caching = 0.) - + linkend="variable.caching">$caching = 0). + + + + If you want to give certain templates their own cache lifetime, you could + do this by setting + $caching = 2, + then set $cache_lifetime to a unique value just + before calling display() + or fetch(). + + + - If $force_compile is + If + $force_compile is enabled, the cache files will be regenerated every time, effectively disabling caching. You can clear all the cache files with the clear_all_cache() function, or - individual cache files (or groups) with the clear_cache() function. + linkend="api.clear.all.cache">clear_all_cache() + function, or individual cache files (or groups) with the clear_cache() function. - - Technical Note - - If you want to give certain templates their own cache lifetime, you could - do this by setting $caching = 2, - then set $cache_lifetime to a unique value just before calling - display() - or fetch(). - - + \ No newline at end of file +--> diff --git a/docs/en/programmers/api-variables/variable-compile-check.xml b/docs/en/programmers/api-variables/variable-compile-check.xml index ea3e3476..2ff1e558 100644 --- a/docs/en/programmers/api-variables/variable-compile-check.xml +++ b/docs/en/programmers/api-variables/variable-compile-check.xml @@ -7,20 +7,23 @@ current template has changed (different time stamp) since the last time it was compiled. If it has changed, it recompiles that template. If the template has not been compiled, it will compile regardless of this - setting. By default this variable is set to true. + setting. By default this variable is set to &true;. Once an application is - put into production (templates won't be changing), the compile_check - step is no longer needed. Be sure to set $compile_check to "false" for - maximal performance. Note that if you change this to "false" and a + put into production (ie the templates won't be changing), + the compile check step is no longer needed. Be sure to set + $compile_check to &false; for + maximal performance. Note that if you change this to &false; and a template file is changed, you will *not* see the change since the template will not get recompiled. If - $caching - is enabled and - $compile_check is enabled, then the cache files will get regenerated if + $caching + is enabled and $compile_check is enabled, then + the cache files will get regenerated if an involved template file or config file was updated. See $force_compile or clear_compiled_tpl(). + linkend="variable.force.compile"> + $force_compile and clear_compiled_tpl() + . \ No newline at end of file +--> diff --git a/docs/en/programmers/api-variables/variable-compile-dir.xml b/docs/en/programmers/api-variables/variable-compile-dir.xml index 898ea80f..04bfb8f7 100644 --- a/docs/en/programmers/api-variables/variable-compile-dir.xml +++ b/docs/en/programmers/api-variables/variable-compile-dir.xml @@ -5,16 +5,14 @@ This is the name of the directory where compiled templates are located. By default this is - "./templates_c" - , meaning that it - will look for the compile directory in the same directory as + ./templates_c, meaning that Smarty + will look for the templates_c/ + directory in the same directory as the executing php script. This directory must - be writeable by the web server - (see install). - Also - $use_sub_dirs. - + be writeable by the web server, + see install for more info. + Technical Note @@ -30,9 +28,9 @@ - See also $compile_id + See also $compile_id and - $use_sub_dirs. + $use_sub_dirs. \ No newline at end of file +--> diff --git a/docs/en/programmers/api-variables/variable-compile-id.xml b/docs/en/programmers/api-variables/variable-compile-id.xml index d07b8a92..437a557e 100644 --- a/docs/en/programmers/api-variables/variable-compile-id.xml +++ b/docs/en/programmers/api-variables/variable-compile-id.xml @@ -4,29 +4,30 @@ $compile_id Persistant compile identifier. As an alternative to passing the same - $compile_id to each and every function call, you can set this - $compile_id and it will be used implicitly thereafter. + $compile_id to each and every function call, you can set this + $compile_id and it will be used implicitly thereafter. - With a $compile_id you can work around the limitation that you cannot - use the same - $compile_dir - for different - $template_dirs. If you set a - distinct $compile_id for each - $template_dir then Smarty can tell the - compiled templates apart by their $compile_id. + With a $compile_id you can work around the limitation + that you cannot use the same + $compile_dir + for different + $template_dirs. If you set a distinct + $compile_id for each + $template_dir + then Smarty can tell the compiled templates apart by their + $compile_id. If you have for example a prefilter that localizes your templates (that is: translates language dependend parts) at compile time, then - you should use the current language as $compile_id and you will get a - set of compiled templates for each language you use. + you could use the current language as $compile_id and + you will get a set of compiled templates for each language you use. - Another example would be to use the same compile directory across + Another application would be to use the same compile directory across multiple domains / multiple virtual hosts. diff --git a/docs/en/programmers/api-variables/variable-config-booleanize.xml b/docs/en/programmers/api-variables/variable-config-booleanize.xml index 966719f4..deb75fe8 100644 --- a/docs/en/programmers/api-variables/variable-config-booleanize.xml +++ b/docs/en/programmers/api-variables/variable-config-booleanize.xml @@ -3,10 +3,15 @@ $config_booleanize - If set to true, config file values of on/true/yes and off/false/no get + If set to &true;, config files + values of on/true/yes + and off/false/no get converted to boolean values automatically. This way you can use the - values in the template like so: {if #foobar#} ... {/if}. If foobar was - on, true or yes, the {if} statement will execute. true by default. + values in the template like so: + {if #foobar#}...{/if}. If foobar was + on, true or yes, + the {if} statement will execute. + Defaults to &true;. \ No newline at end of file +--> diff --git a/docs/en/programmers/api-variables/variable-config-fix-newlines.xml b/docs/en/programmers/api-variables/variable-config-fix-newlines.xml index fd889472..5e509b01 100644 --- a/docs/en/programmers/api-variables/variable-config-fix-newlines.xml +++ b/docs/en/programmers/api-variables/variable-config-fix-newlines.xml @@ -3,8 +3,10 @@ $config_fix_newlines - If set to true, mac and dos newlines (\r and \r\n) in config files are - converted to \n when they are parsed. true by default. + If set to &true;, mac and dos newlines ie '\r' and + '\r\n' in config files are + converted to '\n' when they are parsed. + Default is &true;. \ No newline at end of file +--> diff --git a/docs/en/programmers/api-variables/variable-debugging.xml b/docs/en/programmers/api-variables/variable-debugging.xml index c3455f76..3ad27df9 100644 --- a/docs/en/programmers/api-variables/variable-debugging.xml +++ b/docs/en/programmers/api-variables/variable-debugging.xml @@ -10,18 +10,20 @@ templates, variables assigned from php and config file variables - for the current template page. It does not show variables - assigned within a template with - {assign}. + for the current script. It does not show variables + assigned within a template with the + {assign} + function. - Also see $debugging_ctrl - on how to enable debugging from the url. + The console can also be enabled from the url with + + $debugging_ctrl. See also - {debug}, - $debug_tpl, - and $debugging_ctrl + {debug}, + $debug_tpl, + and $debugging_ctrl. \ No newline at end of file +--> diff --git a/docs/en/programmers/api-variables/variable-default-modifiers.xml b/docs/en/programmers/api-variables/variable-default-modifiers.xml index c068cd02..527dc8b7 100644 --- a/docs/en/programmers/api-variables/variable-default-modifiers.xml +++ b/docs/en/programmers/api-variables/variable-default-modifiers.xml @@ -5,10 +5,12 @@ This is an array of modifiers to implicitly apply to every variable in a template. For example, to HTML-escape every variable by default, use - array('escape:"htmlall"'); To make a variable exempt from default - modifiers, pass the special "smarty" modifier with a parameter value of - "nodefaults" modifier to it, such as - {$var|smarty:nodefaults}. + array('escape:"htmlall"'). + To make a variable exempt from default + modifiers, pass the special smarty modifier with a + parameter value of + nodefaults modifier to it, such as + {$var|smarty:nodefaults}. $request_use_auto_globals - - Specifies if Smarty should use php's $HTTP_*_VARS[] - ($request_use_auto_globals=false) or $_*[] ($request_use_auto_globals=true - which is the default value). This affects templates that make use of - {$smarty.request.*}, {$smarty.get.*} etc. . - Caution: If you set $request_use_auto_globals to true, $request_vars_order - has no effect but php's configuration value - gpc_order is used. + + Specifies if Smarty should use PHP's $HTTP_*_VARS[] + when &false; or $_*[] when + &true; which is the default value. This affects templates that make use of + + {$smarty.request.*}, {$smarty.get.*} etc. + + Caution + + If you set $request_use_auto_globals to true, + + $request_vars_order has no effect but + PHP's configuration value gpc_order is used. + + + \ No newline at end of file +--> diff --git a/docs/en/programmers/api-variables/variable-trusted-dir.xml b/docs/en/programmers/api-variables/variable-trusted-dir.xml index c396fb3f..f9648904 100644 --- a/docs/en/programmers/api-variables/variable-trusted-dir.xml +++ b/docs/en/programmers/api-variables/variable-trusted-dir.xml @@ -3,12 +3,12 @@ $trusted_dir - $trusted_dir is only for use when - $security is enabled. + $trusted_dir is only for use when + $security is enabled. This is an array of all directories that are considered trusted. Trusted directories are where you keep php scripts that are executed directly from the templates - with {include_php}. + with {include_php}.