smarty-php/smarty
1
0
Fork 0
mirror of https://github.com/smarty-php/smarty.git synced 2025-08-04 18:34:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

some WS and program roles

Browse Source
This commit is contained in:
nlopess
2004-04-14 15:53:39 +00:00
parent 4e7edbbd62
commit 35fcd074dd
22 changed files with 187 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en/designers/chapter-debugging-console.xml
View File

@@ -36,6 +36,7 @@
</para>
</note>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -55,4 +56,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

8
docs/en/designers/config-files.xml
View File

@@ -34,7 +34,8 @@ Intro = """This is a value that spans more
host=my.domain.com
db=ADDRESSBOOK
user=php-user
pass=foobar</programlisting>
pass=foobar
</programlisting>
</example>
<para>
Values of config file variables can be in quotes, but not necessary.
@@ -67,7 +68,8 @@ pass=foobar</programlisting>
editing, you can be certain that they cannot read sensitive data from
the config file by loading it into the template.
</para>
</chapter>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -87,4 +89,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

13
docs/en/designers/language-builtin-functions/language-function-capture.xml
View File

@@ -66,17 +66,20 @@
<example>
<title>capturing template content</title>
<programlisting>
<![CDATA[
{* we don't want to print a table row unless content is displayed *}
{capture name=banner}
{include file="get_banner.tpl"}
{/capture}
{if $smarty.capture.banner ne ""}
&lt;tr&gt;
&lt;td&gt;
<tr>
<td>
{$smarty.capture.banner}
&lt;/td&gt;
&lt;/tr&gt;
{/if}</programlisting>
</td>
</tr>
{/if}
]]>
</programlisting>
</example>
</para>
</sect1>

57
docs/en/designers/language-builtin-functions/language-function-config-load.xml
View File

@@ -73,20 +73,23 @@
<title>function config_load</title>
<programlisting>
<![CDATA[
{config_load file="colors.conf"}
&lt;html&gt;
&lt;title&gt;{#pageTitle#}&lt;/title&gt;
&lt;body bgcolor="{#bodyBgColor#}"&gt;
&lt;table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"&gt;
&lt;tr bgcolor="{#rowBgColor#}"&gt;
&lt;td&gt;First&lt;/td&gt;
&lt;td&gt;Last&lt;/td&gt;
&lt;td&gt;Address&lt;/td&gt;
&lt;/tr&gt;
&lt;/table&gt;
&lt;/body&gt;
&lt;/html&gt;</programlisting>
<html>
<title>{#pageTitle#}</title>
<body bgcolor="{#bodyBgColor#}">
<table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}">
<tr bgcolor="{#rowBgColor#}">
<td>First</td>
<td>Last</td>
<td>Address</td>
</tr>
</table>
</body>
</html>
]]>
</programlisting>
</example>
<para>
Config files may also contain sections. You can load variables from
@@ -102,22 +105,26 @@
<example>
<title>function config_load with section</title>
<programlisting>
<![CDATA[
{config_load file="colors.conf" section="Customer"}
&lt;html&gt;
&lt;title&gt;{#pageTitle#}&lt;/title&gt;
&lt;body bgcolor="{#bodyBgColor#}"&gt;
&lt;table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}"&gt;
&lt;tr bgcolor="{#rowBgColor#}"&gt;
&lt;td&gt;First&lt;/td&gt;
&lt;td&gt;Last&lt;/td&gt;
&lt;td&gt;Address&lt;/td&gt;
&lt;/tr&gt;
&lt;/table&gt;
&lt;/body&gt;
&lt;/html&gt;</programlisting>
<html>
<title>{#pageTitle#}</title>
<body bgcolor="{#bodyBgColor#}">
<table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}">
<tr bgcolor="{#rowBgColor#}">
<td>First</td>
<td>Last</td>
<td>Address</td>
</tr>
</table>
</body>
</html>
]]>
</programlisting>
</example>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -137,4 +144,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

26
docs/en/designers/language-builtin-functions/language-function-strip.xml
View File

@@ -27,23 +27,26 @@
<example>
<title>strip tags</title>
<programlisting>
<![CDATA[
{* the following will be all run into one line upon output *}
{strip}
&lt;table border=0&gt;
&lt;tr&gt;
&lt;td&gt;
&lt;A HREF="{$url}"&gt;
&lt;font color="red"&gt;This is a test&lt;/font&gt;
&lt;/A&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;/table&gt;
<table border=0>
<tr>
<td>
<A HREF="{$url}">
<font color="red">This is a test</font>
</A>
</td>
</tr>
</table>
{/strip}
OUTPUT:
&lt;table border=0&gt;&lt;tr&gt;&lt;td&gt;&lt;A HREF="http://my.domain.com"&gt;&lt;font color="red"&gt;This is a test&lt;/font&gt;&lt;/A&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</programlisting>
<table border=0><tr><td><A HREF="http://my.domain.com"><font color="red">This is a test</font></A></td></tr></table>
]]>
</programlisting>
</example>
<para>
Notice that in the above example, all the lines begin and end
@@ -52,6 +55,7 @@ OUTPUT:
they will be run together, and may not be desired results.
</para>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -71,4 +75,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

48
docs/en/designers/language-combining-modifiers.xml
View File

@@ -1,20 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<chapter id="language.combining.modifiers">
<title>Combining Modifiers</title>
<para>
You can apply any number of modifiers to a variable. They will be
applied in the order they are combined, from left to right. They must
be separated with a <literal>|</literal> (pipe) character.
</para>
<example>
<title>combining modifiers</title>
<programlisting>
<chapter id="language.combining.modifiers">
<title>Combining Modifiers</title>
<para>
You can apply any number of modifiers to a variable. They will be
applied in the order they are combined, from left to right. They must
be separated with a <literal>|</literal> (pipe) character.
</para>
<example>
<title>combining modifiers</title>
<programlisting role="php">
<![CDATA[
index.php:
<?php
$smarty = new Smarty;
$smarty-&gt;assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');
$smarty-&gt;display('index.tpl');
$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');
$smarty->display('index.tpl');
?>
index.tpl:
@@ -23,17 +25,23 @@ index.tpl:
{$articleTitle|lower|spacify|truncate}
{$articleTitle|lower|truncate:30|spacify}
{$articleTitle|lower|spacify|truncate:30:". . ."}
OUTPUT:
]]>
</programlisting>
<para>
The above example will output:
</para>
<screen>
<![CDATA[
Smokers are Productive, but Death Cuts Efficiency.
S M O K E R S A R E P R O D U C T I V E , B U T D E A T H C U T S E F F I C I E N C Y .
s m o k e r s a r e p r o d u c t i v e , b u t d e a t h c u t s...
s m o k e r s a r e p r o d u c t i v e , b u t . . .
s m o k e r s a r e p. . .</programlisting>
</example>
</chapter>
s m o k e r s a r e p. . .
]]>
</screen>
</example>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
docs/en/programmers/api-variables/variable-autoload-filters.xml
View File

@@ -19,7 +19,8 @@ $smarty->autoload_filters = array('pre' => array('trim', 'stamp'),
</programlisting>
</informalexample>
</para>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -39,4 +40,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

33
docs/en/programmers/api-variables/variable-cache-dir.xml
View File

@@ -10,21 +10,22 @@
function to control cache files, which will ignore this
setting.
</para>
<note>
<title>Technical Note</title>
<para>
This setting must be either a relative or
absolute path. include_path is not used for writing files.
</para>
</note>
<note>
<title>Technical Note</title>
<para>
It is not recommended to put this directory under
the web server document root.
</para>
</note>
</sect1>
<note>
<title>Technical Note</title>
<para>
This setting must be either a relative or
absolute path. include_path is not used for writing files.
</para>
</note>
<note>
<title>Technical Note</title>
<para>
It is not recommended to put this directory under
the web server document root.
</para>
</note>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -44,4 +45,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

5
docs/en/programmers/api-variables/variable-cache-handler-func.xml
View File

@@ -8,7 +8,8 @@
custom <link linkend="section.template.cache.handler.func">cache
handler function section</link> for details.
</para>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -28,4 +29,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

61
docs/en/programmers/api-variables/variable-cache-lifetime.xml
View File

@@ -1,34 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="variable.cache.lifetime">
<title>$cache_lifetime</title>
<para>
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 set to "true" 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 <link
linkend="variable.caching">$caching</link> = false.)
</para>
<para>
If <link linkend="variable.force.compile">$force_compile</link> is
enabled, the cache files will be regenerated every time, effectively
disabling caching. You can clear all the cache files with the <link
linkend="api.clear.all.cache">clear_all_cache()</link> function, or
individual cache files (or groups) with the <link
linkend="api.clear.cache">clear_cache()</link> function.
</para>
<note>
<title>Technical Note</title>
<para>
If you want to give certain templates their own cache lifetime, you could
do this by setting <link linkend="variable.caching">$caching</link> = 2,
then set $cache_lifetime to a unique value just before calling display()
or fetch().
</para>
</note>
</sect1>
<sect1 id="variable.cache.lifetime">
<title>$cache_lifetime</title>
<para>
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 set to "true" 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 <link
linkend="variable.caching">$caching</link> = false.)
</para>
<para>
If <link linkend="variable.force.compile">$force_compile</link> is
enabled, the cache files will be regenerated every time, effectively
disabling caching. You can clear all the cache files with the <link
linkend="api.clear.all.cache">clear_all_cache()</link> function, or
individual cache files (or groups) with the <link
linkend="api.clear.cache">clear_cache()</link> function.
</para>
<note>
<title>Technical Note</title>
<para>
If you want to give certain templates their own cache lifetime, you could
do this by setting <link linkend="variable.caching">$caching</link> = 2,
then set $cache_lifetime to a unique value just before calling display()
or fetch().
</para>
</note>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -48,4 +49,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

5
docs/en/programmers/api-variables/variable-cache-modified-check.xml
View File

@@ -9,7 +9,8 @@
header will be sent instead of the content. This works only on
cached content without <command>insert</command> tags.
</para>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -29,4 +30,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

7
docs/en/programmers/plugins/plugins-block-functions.xml
View File

@@ -90,9 +90,10 @@ function smarty_block_translate($params, $content, &$smarty)
}
?>
]]>
</programlisting>
</programlisting>
</example>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -112,4 +113,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

7
docs/en/programmers/plugins/plugins-compiler-functions.xml
View File

@@ -64,9 +64,10 @@ function smarty_compiler_tplheader($tag_arg, &$smarty)
echo 'index.tpl compiled at 2002-02-20 20:02';
?>
]]>
</programlisting>
</programlisting>
</example>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -86,4 +87,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

7
docs/en/programmers/plugins/plugins-functions.xml
View File

@@ -99,10 +99,11 @@ function smarty_function_assign($params, &$smarty)
}
?>
]]>
</programlisting>
</programlisting>
</example>
</para>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -122,4 +123,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

3
docs/en/programmers/plugins/plugins-howto.xml
View File

@@ -22,6 +22,7 @@
directories and Smarty will use it automatically.
</para>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -41,4 +42,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

7
docs/en/programmers/plugins/plugins-inserts.xml
View File

@@ -48,9 +48,10 @@ function smarty_insert_time($params, &$smarty)
}
?>
]]>
</programlisting>
</programlisting>
</example>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -70,4 +71,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

7
docs/en/programmers/plugins/plugins-modifiers.xml
View File

@@ -89,9 +89,10 @@ function smarty_modifier_truncate($string, $length = 80, $etc = '...',
}
?>
]]>
</programlisting>
</programlisting>
</example>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -111,4 +112,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

5
docs/en/programmers/plugins/plugins-naming-conventions.xml
View File

@@ -56,7 +56,8 @@
needs is not found, or if the file or the plugin function are named
improperly.
</para>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -76,4 +77,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

5
docs/en/programmers/plugins/plugins-outputfilters.xml
View File

@@ -42,7 +42,8 @@
]]>
</programlisting>
</example>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -62,4 +63,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

9
docs/en/programmers/plugins/plugins-prefilters-postfilters.xml
View File

@@ -56,7 +56,7 @@
}
?>
]]>
</programlisting>
</programlisting>
</example>
<para></para>
<example>
@@ -80,9 +80,10 @@
}
?>
]]>
</programlisting>
</programlisting>
</example>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -102,4 +103,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

7
docs/en/programmers/plugins/plugins-resources.xml
View File

@@ -134,9 +134,10 @@ function smarty_resource_db_trusted($tpl_name, &$smarty)
}
?>
]]>
</programlisting>
</programlisting>
</example>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -156,4 +157,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->

5
docs/en/programmers/plugins/plugins-writing.xml
View File

@@ -31,7 +31,8 @@ require_once $smarty->_get_plugin_filepath('function', 'html_options');
<parameter>&amp;$repeat</parameter> after the Smarty object to keep
backwards compatibility to older versions of Smarty).
</para>
</sect1>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -51,4 +52,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->