cvs: smarty /docs/en/designers/language-basic-syntax language-escaping.xml language-math.xml language-syntax-comments.xml language-syntax-functions.xml language-syntax-quotes.xml language-syntax-variables.xml
"Peter 'Mash' Morgan" <[email protected]> Tue, 26 Sep 2006 02:42:08 -0000
| Newsgroups | gmane.comp.php.cvs.smarty |
|---|---|
| Message-ID | <cvspete_morgan1159238528@cvsserver> |
pete_morgan Tue Sep 26 02:42:08 2006 UTC
Modified files:
/smarty/docs/en/designers/language-basic-syntax
language-escaping.xml
language-math.xml
language-syntax-comments.xml
language-syntax-functions.xml
language-syntax-quotes.xml
language-syntax-variables.xml
Log:
Formatting of the basic-syntax dir
--
Smarty CVS Mailing List (http://cvs.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
pete_morgan-20060926024208.txt
(text/plain, 13.1 KB)
http://cvs.php.net/viewvc.cgi/smarty/docs/en/designers/language-basic-syntax/language-escaping.xml?r1=1.7&r2=1.8&diff_format=u
Index: smarty/docs/en/designers/language-basic-syntax/language-escaping.xml
diff -u smarty/docs/en/designers/language-basic-syntax/language-escaping.xml:1.7 smarty/docs/en/designers/language-basic-syntax/language-escaping.xml:1.8
--- smarty/docs/en/designers/language-basic-syntax/language-escaping.xml:1.7 Sat Feb 18 13:43:35 2006
+++ smarty/docs/en/designers/language-basic-syntax/language-escaping.xml Tue Sep 26 02:42:08 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<sect1 id="language.escaping">
<title>Escaping Smarty Parsing</title>
<para>
@@ -17,18 +17,21 @@
<para>
Including literal content is possible using <link
- linkend="language.function.literal">{literal} .. {/literal}</link> blocks.
+ linkend="language.function.literal">
+ <varname>{literal}..{/literal}</varname></link> blocks.
Similar to HTML entity usage, you can use <link
- linkend="language.function.ldelim">{ldelim}</link>,<link
- linkend="language.function.ldelim">{rdelim}</link> or <link
- linkend="language.variables.smarty.ldelim">{$smarty.ldelim}</link>
- to display the current delimiters.
+ linkend="language.function.ldelim"><varname>{ldelim}</varname></link>,<link
+ linkend="language.function.ldelim"><varname>{rdelim}</varname></link> or <link
+ linkend="language.variables.smarty.ldelim">
+ <varname>{$smarty.ldelim}</varname></link> to display the current delimiters.
</para>
<para>
It is often convenient to simply change Smarty's <link
- linkend="variable.left.delimiter">$left_delimiter</link> and
- <link linkend="variable.right.delimiter">$right_delimiter</link>.
+ linkend="variable.left.delimiter">
+ <parameter>$left_delimiter</parameter></link> and
+ <link linkend="variable.right.delimiter">
+ <parameter>$right_delimiter</parameter></link>.
</para>
<example>
<title>changing delimiters example</title>
@@ -36,9 +39,9 @@
<![CDATA[
<?php
-$smarty = new Smarty;
$smarty->left_delimiter = '<!--{';
$smarty->right_delimiter = '}-->';
+
$smarty->assign('foo', 'bar');
$smarty->assign('name', 'Albert');
$smarty->display('example.tpl');
@@ -47,7 +50,7 @@
]]>
</programlisting>
<para>
- Where example.tpl is:
+ Where the template is:
</para>
<programlisting>
<![CDATA[
@@ -62,9 +65,6 @@
]]>
</programlisting>
</example>
- <para>
- See also <link linkend="language.modifier.escape">escape modifier</link>
- </para>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/smarty/docs/en/designers/language-basic-syntax/language-math.xml?r1=1.4&r2=1.5&diff_format=u
Index: smarty/docs/en/designers/language-basic-syntax/language-math.xml
diff -u smarty/docs/en/designers/language-basic-syntax/language-math.xml:1.4 smarty/docs/en/designers/language-basic-syntax/language-math.xml:1.5
--- smarty/docs/en/designers/language-basic-syntax/language-math.xml:1.4 Tue Sep 13 19:32:43 2005
+++ smarty/docs/en/designers/language-basic-syntax/language-math.xml Tue Sep 26 02:42:08 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<sect1 id="language.math">
<title>Math</title>
<para>
@@ -27,7 +27,9 @@
</example>
<para>
- See also the <link linkend="language.function.math">{math}</link> function for complex equations.
+ See also the <link linkend="language.function.math">
+ <varname>{math}</varname></link> function for complex equations
+ and <link linkend="language.function.eval"><varname>{eval}</varname></link>.
</para>
</sect1>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/smarty/docs/en/designers/language-basic-syntax/language-syntax-comments.xml?r1=1.11&r2=1.12&diff_format=u
Index: smarty/docs/en/designers/language-basic-syntax/language-syntax-comments.xml
diff -u smarty/docs/en/designers/language-basic-syntax/language-syntax-comments.xml:1.11 smarty/docs/en/designers/language-basic-syntax/language-syntax-comments.xml:1.12
--- smarty/docs/en/designers/language-basic-syntax/language-syntax-comments.xml:1.11 Tue Mar 28 00:27:52 2006
+++ smarty/docs/en/designers/language-basic-syntax/language-syntax-comments.xml Tue Sep 26 02:42:08 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<sect1 id="language.syntax.comments">
<title>Comments</title>
<para>
@@ -9,7 +9,7 @@
tags like so: <emphasis>{* this is a comment *}</emphasis>
Smarty comments are NOT displayed in the final output of the template,
unlike <!-- HTML comments -->
- these are useful for making internal notes in the templates which no one will see;-).
+ these are useful for making internal notes in the templates which no one will see ;-)
</para>
<example>
<title>Comments within a template</title>
@@ -25,7 +25,7 @@
{* another single line smarty comment *}
<!-- HTML comment that is sent to the browser -->
-{* this multiline smarty
+{* this multiline smarty
comment is
not sent to browser
*}
@@ -34,10 +34,10 @@
Multi line comment block with credits block
@ author: [email protected]
@ maintainer: [email protected]
- @ para: var that sets block style
+ @ para: var that sets block style
@ css: the style output
**********************************************************}
-
+
{* The header file with the main logo and stuff *}
{include file='header.tpl'}
@@ -53,7 +53,7 @@
</select>
*}
-{* cvs tag for a template, below the 36 SHOULD be an american currency
+{* cvs tag for a template, below the 36 SHOULD be an american currency
. however its converted in cvs.. *}
{* $Id: Exp $ *}
{* $Id: *}
http://cvs.php.net/viewvc.cgi/smarty/docs/en/designers/language-basic-syntax/language-syntax-functions.xml?r1=1.9&r2=1.10&diff_format=u
Index: smarty/docs/en/designers/language-basic-syntax/language-syntax-functions.xml
diff -u smarty/docs/en/designers/language-basic-syntax/language-syntax-functions.xml:1.9 smarty/docs/en/designers/language-basic-syntax/language-syntax-functions.xml:1.10
--- smarty/docs/en/designers/language-basic-syntax/language-syntax-functions.xml:1.9 Tue Mar 28 00:12:33 2006
+++ smarty/docs/en/designers/language-basic-syntax/language-syntax-functions.xml Tue Sep 26 02:42:08 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<sect1 id="language.syntax.functions">
<title>Functions</title>
<para>
@@ -8,11 +8,11 @@
of function. These are processed and displayed by enclosing the
function and its
<link linkend="language.syntax.attributes">attributes</link>
- within delimiters like so: {funcname
- attr1='val1' attr2='val2'}.
+ within delimiters like so:
+ <literal>{funcname attr1='val1' attr2='val2'}</literal>.
</para>
<example>
- <title>function syntax</title>
+ <title>function syntax </title>
<programlisting>
<![CDATA[
{config_load file='colors.conf'}
@@ -30,28 +30,35 @@
]]>
</programlisting>
</example>
- <para>
+
+ <itemizedlist>
+ <listitem><para>
Both <link linkend="language.builtin.functions">built-in functions</link>
and <link linkend="language.custom.functions">custom functions</link>
have the same syntax within templates.
- </para>
- <para>Built-in functions are the
+ </para></listitem>
+
+ <listitem><para>Built-in functions are the
<emphasis role="bold">inner</emphasis> workings of Smarty, such as
- <link linkend="language.function.if">{if}</link>,
- <link linkend="language.function.section">{section}</link> and
- <link linkend="language.function.strip">{strip}</link>.
+ <link linkend="language.function.if"><varname>{if}</varname></link>,
+ <link linkend="language.function.section"><varname>{section}</varname></link> and
+ <link linkend="language.function.strip"><varname>{strip}</varname></link>.
There should be no need to change or modify them.
- </para>
- <para>Custom functions are <emphasis role="bold">additional</emphasis>
+ </para></listitem>
+
+ <listitem><para>Custom functions are
+ <emphasis role="bold">additional</emphasis>
functions implemented via <link linkend="plugins">plugins</link>.
They can be modified to your liking, or you can create new ones.
- <link linkend="language.function.html.options">{html_options}</link> and
- <link linkend="language.function.popup">{popup}</link>
+ <link linkend="language.function.html.options">
+ <varname>{html_options}</varname></link> and
+ <link linkend="language.function.popup"><varname>{popup}</varname></link>
are examples of custom functions.
- </para>
-
+ </para></listitem>
+</itemizedlist>
+
<para>
- See also <link linkend="api.register.function">register_function()</link>
+ See also <link linkend="api.register.function"><varname>register_function()</varname></link>
</para>
</sect1>
http://cvs.php.net/viewvc.cgi/smarty/docs/en/designers/language-basic-syntax/language-syntax-quotes.xml?r1=1.8&r2=1.9&diff_format=u
Index: smarty/docs/en/designers/language-basic-syntax/language-syntax-quotes.xml
diff -u smarty/docs/en/designers/language-basic-syntax/language-syntax-quotes.xml:1.8 smarty/docs/en/designers/language-basic-syntax/language-syntax-quotes.xml:1.9
--- smarty/docs/en/designers/language-basic-syntax/language-syntax-quotes.xml:1.8 Sat Feb 18 13:43:35 2006
+++ smarty/docs/en/designers/language-basic-syntax/language-syntax-quotes.xml Tue Sep 26 02:42:08 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<sect1 id="language.syntax.quotes">
<title>Embedding Vars in Double Quotes</title>
<para>
@@ -7,12 +7,13 @@
linkend="api.assign">assigned</link>
<link linkend="language.syntax.variables">variables</link>
embedded in double quotes so long as the variable name contains only numbers,
- letters, underscores and brackets []. With any other characters (period,
- object reference, etc.) the variable must be surrounded by
- <link linkend="language.syntax.quotes">backticks</link>. You
- cannot embed
- <link linkend="language.modifiers">modifiers</link>,
- they must always be applied outside of quotes.
+ letters, underscores and brackets[]
+ (see <ulink url="&url.php-manual;language.variables">naming</ulink>).
+ With any other characters (period,
+ object reference, etc.) the variable must be surrounded by
+ `backticks`. You cannot embed
+ <link linkend="language.modifiers">modifiers</link>, they must always
+ be applied outside of quotes.
</para>
<example>
<title>embedded quotes syntax</title>
@@ -34,7 +35,7 @@
</programlisting>
</example>
<para>
- See also <link linkend="language.modifier.escape">escape</link>.
+ See also <link linkend="language.modifier.escape"><varname>escape</varname></link>.
</para>
</sect1>
http://cvs.php.net/viewvc.cgi/smarty/docs/en/designers/language-basic-syntax/language-syntax-variables.xml?r1=1.14&r2=1.15&diff_format=u
Index: smarty/docs/en/designers/language-basic-syntax/language-syntax-variables.xml
diff -u smarty/docs/en/designers/language-basic-syntax/language-syntax-variables.xml:1.14 smarty/docs/en/designers/language-basic-syntax/language-syntax-variables.xml:1.15
--- smarty/docs/en/designers/language-basic-syntax/language-syntax-variables.xml:1.14 Fri Apr 21 09:34:15 2006
+++ smarty/docs/en/designers/language-basic-syntax/language-syntax-variables.xml Tue Sep 26 02:42:08 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.14 $ -->
+<!-- $Revision: 1.15 $ -->
<sect1 id="language.syntax.variables">
<title>Variables</title>
<para>
@@ -13,8 +13,9 @@
<link linkend="language.config.variables">Config file variables</link>
are an exception to the $dollar syntax
and are instead referenced with surrounding #hashmarks#, or
- via the
- <link linkend="language.variables.smarty.config">$smarty.config</link> variable.
+ via the
+ <link linkend="language.variables.smarty.config">
+ <parameter>$smarty.config</parameter></link> variable.
</para>
<example>
<title>Variables</title>
@@ -46,17 +47,20 @@
]]>
</programlisting>
</example>
-
- <para>Request variables such as $_GET, $_SESSION etc are available via the <emphasis role="bold">
- <link linkend="language.variables.smarty">$smarty</link></emphasis> reserved variable.
+
+ <para>Request variables such as <literal>$_GET</literal>,
+ <literal>$_SESSION</literal>, etc are available via the
+ reserved <link linkend="language.variables.smarty">
+ <parameter>$smarty</parameter></link> variable.
</para>
-
+
<para>
- See also <link linkend="language.variables.smarty">$smarty reserved variables</link>,
- <link linkend="language.config.variables">Config Variables</link>
- <link linkend="language.function.assign">{assign}</link>
+ See also <link linkend="language.variables.smarty">
+ <parameter>$smarty</parameter></link>,
+ <link linkend="language.config.variables">config variables</link>
+ <link linkend="language.function.assign"><varname>{assign}</varname></link>
and
- <link linkend="api.assign">assign()</link>.
+ <link linkend="api.assign"><varname>assign()</varname></link>.
</para>
</sect1>