diff --git a/docs/en/designers/language-custom-functions/language-function-counter.xml b/docs/en/designers/language-custom-functions/language-function-counter.xml
index d86e4dfa..cea4d6cc 100644
--- a/docs/en/designers/language-custom-functions/language-function-counter.xml
+++ b/docs/en/designers/language-custom-functions/language-function-counter.xml
@@ -1,99 +1,106 @@
-
- counter
-
-
-
-
-
-
-
-
-
- Attribute Name
- Type
- Required
- Default
- Description
-
-
-
-
- name
- string
- No
- default
- The name of the counter
-
-
- start
- number
- No
- 1
- The initial number to start counting from
-
-
- skip
- number
- No
- 1
- The interval to count by
-
-
- direction
- string
- No
- up
- the direction to count (up/down)
-
-
- print
- boolean
- No
- true
- Whether or not to print the value
-
-
- assign
- string
- No
- n/a
- the template variable the output will be assigned
+
+ counter
+
+
+
+
+
+
+
+
+
+ Attribute Name
+ Type
+ Required
+ Default
+ Description
+
+
+
+
+ name
+ string
+ No
+ default
+ The name of the counter
+
+
+ start
+ number
+ No
+ 1
+ The initial number to start counting from
+
+
+ skip
+ number
+ No
+ 1
+ The interval to count by
+
+
+ direction
+ string
+ No
+ up
+ the direction to count (up/down)
+
+
+ print
+ boolean
+ No
+ true
+ Whether or not to print the value
+
+
+ assign
+ string
+ No
+ n/a
+ the template variable the output will be assigned
to
-
-
-
-
-
- counter is used to print out a count. counter will remember the
- count on each iteration. You can adjust the number, the interval
- and the direction of the count, as well as determine whether or not
- to print the value. You can run multiple counters concurrently by
- supplying a unique name for each one. If you do not supply a name,
- the name 'default' will be used.
-
-
- If you supply the special "assign" attribute, the output of the
- counter function will be assigned to this template variable instead of
- being output to the template.
-
-
-counter
-
+
+
+
+
+
+ counter is used to print out a count. counter will remember the
+ count on each iteration. You can adjust the number, the interval
+ and the direction of the count, as well as determine whether or not
+ to print the value. You can run multiple counters concurrently by
+ supplying a unique name for each one. If you do not supply a name,
+ the name 'default' will be used.
+
+
+ If you supply the special "assign" attribute, the output of the
+ counter function will be assigned to this template variable instead of
+ being output to the template.
+
+
+ counter
+
+
-
+{counter start=0 skip=2}
+{counter}
+{counter}
+{counter}
+]]>
+
+
+ this will output:
+
+
+
+2
+4
+6
+]]>
+
+
-
- cycle
-
-
-
-
-
-
-
-
-
- Attribute Name
- Type
- Required
- Default
- Description
-
-
-
-
- name
- string
- No
- default
- The name of the cycle
-
-
- values
- mixed
- Yes
- N/A
- The values to cycle through, either a comma
- delimited list (see delimiter attribute), or an array
- of values.
-
-
- print
- boolean
- No
- true
- Whether to print the value or not
-
-
- advance
- boolean
- No
- true
- Whether or not to advance to the next value
-
-
- delimiter
- string
- No
- ,
- The delimiter to use in the values attribute.
-
-
- assign
- string
- No
- n/a
- the template variable the output will be assigned
- to
-
-
-
-
-
- Cycle is used to cycle though a set of values. This makes it easy
- to alternate between two or more colors in a table, or cycle
- through an array of values.
-
-
- You can cycle through more than one set of values in your template
- by supplying a name attribute. Give each set of values a unique
- name.
-
-
- You can force the current value not to print with the print
- attribute set to false. This would be useful for silently skipping
- a value.
-
-
- The advance attribute is used to repeat a value. When set to false,
- the next call to cycle will print the same value.
-
-
- If you supply the special "assign" attribute, the output of the
- cycle function will be assigned to this template variable instead of
- being output to the template.
-
-
-cycle
-
+
+ cycle
+
+
+
+
+
+
+
+
+
+ Attribute Name
+ Type
+ Required
+ Default
+ Description
+
+
+
+
+ name
+ string
+ No
+ default
+ The name of the cycle
+
+
+ values
+ mixed
+ Yes
+ N/A
+ The values to cycle through, either a comma
+ delimited list (see delimiter attribute), or an array
+ of values.
+
+
+ print
+ boolean
+ No
+ true
+ Whether to print the value or not
+
+
+ advance
+ boolean
+ No
+ true
+ Whether or not to advance to the next value
+
+
+ delimiter
+ string
+ No
+ ,
+ The delimiter to use in the values attribute.
+
+
+ assign
+ string
+ No
+ n/a
+ the template variable the output will be assigned
+ to
+
+
+
+
+
+ Cycle is used to cycle though a set of values. This makes it easy
+ to alternate between two or more colors in a table, or cycle
+ through an array of values.
+
+
+ You can cycle through more than one set of values in your template
+ by supplying a name attribute. Give each set of values a unique
+ name.
+
+
+ You can force the current value not to print with the print
+ attribute set to false. This would be useful for silently skipping
+ a value.
+
+
+ The advance attribute is used to repeat a value. When set to false,
+ the next call to cycle will print the same value.
+
+
+ If you supply the special "assign" attribute, the output of the
+ cycle function will be assigned to this template variable instead of
+ being output to the template.
+
+
+ cycle
+
+
+
+]]>
+
+
-
- debug
-
-
-
-
-
-
-
-
-
- Attribute Name
- Type
- Required
- Default
- Description
-
-
-
-
- output
- string
- No
- html
- output type, html or javascript
-
-
-
-
-
- {debug} dumps the debug console to the page. This works regardless
- of the debug
- settings in Smarty. Since this gets executed at runtime, this is
- only able to show the assigned variables, not the templates that
- are in use. But, you see all the currently available variables
- within the scope of this template.
-
+
+ debug
+
+
+
+
+
+
+
+
+
+ Attribute Name
+ Type
+ Required
+ Default
+ Description
+
+
+
+
+ output
+ string
+ No
+ html
+ output type, html or javascript
+
+
+
+
+
+ {debug} dumps the debug console to the page. This works regardless
+ of the debug
+ settings in Smarty. Since this gets executed at runtime, this is
+ only able to show the assigned variables, not the templates that
+ are in use. But, you see all the currently available variables
+ within the scope of this template.
+
-
- fetch
-
-
-
-
-
-
-
-
-
- Attribute Name
- Type
- Required
- Default
- Description
-
-
-
-
- file
- string
- Yes
- n/a
- the file, http or ftp site to fetch
-
-
- assign
- string
- No
- n/a
- the template variable the output will be assigned
- to
-
-
-
-
-
- fetch is used to fetch files from the local file system, http, or
- ftp and display the contents. If the file name begins with
- "http://", the web site page will be fetched and displayed. If the
- file name begins with "ftp://", the file will be fetched from the
- ftp server and displayed. For local files, the full system file
- path must be given, or a path relative to the executed php script.
-
-
- If you supply the special "assign" attribute, the output of the
- fetch function will be assigned to this template variable instead of
- being output to the template. (new in Smarty 1.5.0)
-
-
- Technical Note
-
- This will not support http redirects, be sure to
- include a trailing slash on your web page fetches where necessary.
-
-
-
- Technical Note
-
- If template security is turned on and you are
- fetching a file from the local file system, this will only allow
- files from within one of the defined secure directories.
- ($secure_dir)
-
-
-
-fetch
-
+
+ fetch
+
+
+
+
+
+
+
+
+
+ Attribute Name
+ Type
+ Required
+ Default
+ Description
+
+
+
+
+ file
+ string
+ Yes
+ n/a
+ the file, http or ftp site to fetch
+
+
+ assign
+ string
+ No
+ n/a
+ the template variable the output will be assigned
+ to
+
+
+
+
+
+ fetch is used to fetch files from the local file system, http, or
+ ftp and display the contents. If the file name begins with
+ "http://", the web site page will be fetched and displayed. If the
+ file name begins with "ftp://", the file will be fetched from the
+ ftp server and displayed. For local files, the full system file
+ path must be given, or a path relative to the executed php script.
+
+
+ If you supply the special "assign" attribute, the output of the
+ fetch function will be assigned to this template variable instead of
+ being output to the template. (new in Smarty 1.5.0)
+
+
+ Technical Note
+
+ This will not support http redirects, be sure to
+ include a trailing slash on your web page fetches where necessary.
+
+
+
+ Technical Note
+
+ If template security is turned on and you are
+ fetching a file from the local file system, this will only allow
+ files from within one of the defined secure directories.
+ ($secure_dir)
+
+
+
+ fetch
+
+
-
+ {$weather}
+{/if}
+]]
+
+
-
- html_checkboxes
-
-
-
-
-
-
-
-
-
- Attribute Name
- Type
- Required
- Default
- Description
-
-
-
-
- name
- string
- No
- checkbox
- name of checkbox list
-
-
- values
- array
- Yes, unless using options attribute
- n/a
- an array of values for checkbox buttons
-
-
- output
- array
- Yes, unless using options attribute
- n/a
- an array of output for checkbox buttons
-
-
- selected
- string/array
- No
- empty
- the selected checkbox element(s)
-
-
- options
- associative array
- Yes, unless using values and output
- n/a
- an associative array of values and output
-
-
- separator
- string
- No
- empty
- string of text to separate each checkbox item
-
-
- labels
- boolean
- No
- true
- add <label>-tags to the output
-
-
-
-
-
- html_checkboxes is a custom function that creates an html checkbox
- group with provided data. It takes care of which item(s) are
- selected by default as well. Required attributes are values and
- output, unless you use options instead. All output is XHTML
- compatible.
-
-
- All parameters that are not in the list above are printed as
- name/value-pairs inside each of the created <input>-tags.
-
-
-html_checkboxes
-
-index.php:
+
+ html_checkboxes
+
+
+
+
+
+
+
+
+
+ Attribute Name
+ Type
+ Required
+ Default
+ Description
+
+
+
+
+ name
+ string
+ No
+ checkbox
+ name of checkbox list
+
+
+ values
+ array
+ Yes, unless using options attribute
+ n/a
+ an array of values for checkbox buttons
+
+
+ output
+ array
+ Yes, unless using options attribute
+ n/a
+ an array of output for checkbox buttons
+
+
+ selected
+ string/array
+ No
+ empty
+ the selected checkbox element(s)
+
+
+ options
+ associative array
+ Yes, unless using values and output
+ n/a
+ an associative array of values and output
+
+
+ separator
+ string
+ No
+ empty
+ string of text to separate each checkbox item
+
+
+ labels
+ boolean
+ No
+ true
+ add <label>-tags to the output
+
+
+
+
+
+ html_checkboxes is a custom function that creates an html checkbox
+ group with provided data. It takes care of which item(s) are
+ selected by default as well. Required attributes are values and
+ output, unless you use options instead. All output is XHTML
+ compatible.
+
+
+ All parameters that are not in the list above are printed as
+ name/value-pairs inside each of the created <input>-tags.
+
+
+ html_checkboxes
+
+assign('cust_ids', array(1000,1001,1002,1003));
+$smarty->assign('cust_names', array('Joe Schmoe','Jack Smith','Jane Johnson','Charlie Brown'));
+$smarty->assign('customer_id', 1001);
+$smarty->display('index.tpl');
-
-index.tpl:
-
-{html_checkboxes name="id" values=$cust_ids selected=$customer_id output=$cust_names separator="<br />"}
-
-
-index.php:
+?>
+]]
+
+
+ where index.tpl is:
+
+
+"}
+]]
+
+
+assign('cust_checkboxes', array(
+ 1000 => 'Joe Schmoe',
+ 1001 => 'Jack Smith',
+ 1002 => 'Jane Johnson',
+ 1003 => 'Charlie Brown'));
+$smarty->assign('customer_id', 1001);
+$smarty->display('index.tpl');
+?>
+]]>
+
+
+ where index.tpl is:
+
+
+
-
+]]>
+
+
+ both examples will output:
+
+
+Joe Schmoe
+
+
+
+]]>
+
+
-
- html_select_time
-
-
-
-
-
-
-
-
-
- Attribute Name
- Type
- Required
- Default
- Description
-
-
-
-
- prefix
- string
- No
- Time_
- what to prefix the var name with
-
-
- time
- timestamp
- No
- current time
- what date/time to use
-
-
- display_hours
- boolean
- No
- true
- whether or not to display hours
-
-
- display_minutes
- boolean
- No
- true
- whether or not to display minutes
-
-
- display_seconds
- boolean
- No
- true
- whether or not to display seconds
-
-
- display_meridian
- boolean
- No
- true
- whether or not to display meridian (am/pm)
-
-
- use_24_hours
- boolean
- No
- true
- whether or not to use 24 hour clock
-
-
- minute_interval
- integer
- No
- 1
- number interval in minute dropdown
-
-
- second_interval
- integer
- No
- 1
- number interval in second dropdown
-
-
- field_array
- string
- No
- n/a
- outputs values to array of this name
-
-
- all_extra
- string
- No
- null
- adds extra attributes to select/input tags if
+
+ html_select_time
+
+
+
+
+
+
+
+
+
+ Attribute Name
+ Type
+ Required
+ Default
+ Description
+
+
+
+
+ prefix
+ string
+ No
+ Time_
+ what to prefix the var name with
+
+
+ time
+ timestamp
+ No
+ current time
+ what date/time to use
+
+
+ display_hours
+ boolean
+ No
+ true
+ whether or not to display hours
+
+
+ display_minutes
+ boolean
+ No
+ true
+ whether or not to display minutes
+
+
+ display_seconds
+ boolean
+ No
+ true
+ whether or not to display seconds
+
+
+ display_meridian
+ boolean
+ No
+ true
+ whether or not to display meridian (am/pm)
+
+
+ use_24_hours
+ boolean
+ No
+ true
+ whether or not to use 24 hour clock
+
+
+ minute_interval
+ integer
+ No
+ 1
+ number interval in minute dropdown
+
+
+ second_interval
+ integer
+ No
+ 1
+ number interval in second dropdown
+
+
+ field_array
+ string
+ No
+ n/a
+ outputs values to array of this name
+
+
+ all_extra
+ string
+ No
+ null
+ adds extra attributes to select/input tags if
given
-
-
- hour_extra
- string
- No
- null
- adds extra attributes to select/input tags if
+
+
+ hour_extra
+ string
+ No
+ null
+ adds extra attributes to select/input tags if
given
-
-
- minute_extra
- string
- No
- null
- adds extra attributes to select/input tags if
+
+
+ minute_extra
+ string
+ No
+ null
+ adds extra attributes to select/input tags if
given
-
-
- second_extra
- string
- No
- null
- adds extra attributes to select/input tags if
+
+
+ second_extra
+ string
+ No
+ null
+ adds extra attributes to select/input tags if
given
-
-
- meridian_extra
- string
- No
- null
- adds extra attributes to select/input tags if
+
+
+ meridian_extra
+ string
+ No
+ null
+ adds extra attributes to select/input tags if
given
-
-
-
-
-
- html_select_time is a custom function that
- creates time dropdowns for you. It can display
- any or all of hour, minute, second and
- meridian.
-
-
- The time-attribute can have different
- formats. It can be a uniq-timestamp or a
- string containing Y-M-D. YYYY-MM-DD may be the
- most common, but months and days with less
- than two digits are also recognized. If one of
- the 3 values (Y,M,D) is the empty string, than
- the according select-box is not pre-selected
- at all. This is especially useful with the
- empty_year-, -month- and -day-attritbutes.
-
-
-
-html_select_time
-
+
+
+
+
+
+ html_select_time is a custom function that
+ creates time dropdowns for you. It can display
+ any or all of hour, minute, second and
+ meridian.
+
+
+ The time-attribute can have different
+ formats. It can be a uniq-timestamp or a
+ string containing Y-M-D. YYYY-MM-DD may be the
+ most common, but months and days with less
+ than two digits are also recognized. If one of
+ the 3 values (Y,M,D) is the empty string, than
+ the according select-box is not pre-selected
+ at all. This is especially useful with the
+ empty_year-, -month- and -day-attritbutes.
+
+
+ html_select_time
+
+
-
+]]>
+
+
+ This will output:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+]]>
+
+
-
- popup_init
-
- popup is an integration of overLib, a library used for popup
- windows. These are used for context sensitive information, such as
- help windows or tooltips. popup_init must be called once at the
- top of any page you plan on using the popup function. overLib
- was written by Erik Bosrup, and the homepage is located at
- http://www.bosrup.com/web/overlib/.
-
-
- As of Smarty version 2.1.2, overLib does NOT come with the release.
- Download overLib, place the overlib.js file under your document
- root and supply the relative path to this file as the "src"
- parameter to popup_init.
-
-
-popup_init
-
+
+ popup_init
+
+ popup is an integration of overLib, a library used for popup
+ windows. These are used for context sensitive information, such as
+ help windows or tooltips. popup_init must be called once at the
+ top of any page you plan on using the popup function. overLib
+ was written by Erik Bosrup, and the homepage is located at
+ http://www.bosrup.com/web/overlib/.
+
+
+ As of Smarty version 2.1.2, overLib does NOT come with the release.
+ Download overLib, place the overlib.js file under your document
+ root and supply the relative path to this file as the "src"
+ parameter to popup_init.
+
+
+ popup_init
+
+
-
+{popup_init src="/javascripts/overlib.js"}
+]]>
+
+