diff --git a/docs/en/designers/language-custom-functions/language-function-assign.xml b/docs/en/designers/language-custom-functions/language-function-assign.xml index fcf9a64c..f99e946b 100644 --- a/docs/en/designers/language-custom-functions/language-function-assign.xml +++ b/docs/en/designers/language-custom-functions/language-function-assign.xml @@ -2,6 +2,12 @@ {assign} + + {assign} is used for assigning template variables + during the execution + of the template. + + @@ -36,11 +42,7 @@ - - {assign} is used for assigning template variables - during the execution - of the template. - + {assign} 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 1c130e66..1bd7381d 100644 --- a/docs/en/designers/language-custom-functions/language-function-counter.xml +++ b/docs/en/designers/language-custom-functions/language-function-counter.xml @@ -2,6 +2,20 @@ {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. + + @@ -64,19 +78,7 @@ - - {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 diff --git a/docs/en/designers/language-custom-functions/language-function-cycle.xml b/docs/en/designers/language-custom-functions/language-function-cycle.xml index fc4489c3..11135ebf 100644 --- a/docs/en/designers/language-custom-functions/language-function-cycle.xml +++ b/docs/en/designers/language-custom-functions/language-function-cycle.xml @@ -2,6 +2,12 @@ {cycle} + + {cycle} is used to cycle though a set of values. This makes it easy + to alternate for example between two or more colors in a table, or cycle + through an array of values. + + @@ -74,11 +80,7 @@ - - {cycle} is used to cycle though a set of values. This makes it easy - to alternate for example 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 diff --git a/docs/en/designers/language-custom-functions/language-function-eval.xml b/docs/en/designers/language-custom-functions/language-function-eval.xml index 5cb17d8a..9a02b995 100644 --- a/docs/en/designers/language-custom-functions/language-function-eval.xml +++ b/docs/en/designers/language-custom-functions/language-function-eval.xml @@ -2,6 +2,17 @@ {eval} + + {eval} is used to evaluate a variable as a template. This can be used + for things like embedding template tags/variables into variables or + tags/variables into config file variables. + + + If you supply the special "assign" attribute, the output of the + {eval} function will be assigned to this template variable instead of + being output to the template. + + @@ -37,16 +48,7 @@ - - {eval} is used to evaluate a variable as a template. This can be used - for things like embedding template tags/variables into variables or - tags/variables into config file variables. - - - If you supply the special "assign" attribute, the output of the - {eval} function will be assigned to this template variable instead of - being output to the template. - + Technical Note diff --git a/docs/en/designers/language-custom-functions/language-function-fetch.xml b/docs/en/designers/language-custom-functions/language-function-fetch.xml index a7a5be07..735b79c2 100644 --- a/docs/en/designers/language-custom-functions/language-function-fetch.xml +++ b/docs/en/designers/language-custom-functions/language-function-fetch.xml @@ -2,6 +2,20 @@ {fetch} + + {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) + + @@ -37,19 +51,7 @@ - - {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 diff --git a/docs/en/designers/language-custom-functions/language-function-html-checkboxes.xml b/docs/en/designers/language-custom-functions/language-function-html-checkboxes.xml index 640edfa6..d31bce24 100644 --- a/docs/en/designers/language-custom-functions/language-function-html-checkboxes.xml +++ b/docs/en/designers/language-custom-functions/language-function-html-checkboxes.xml @@ -2,6 +2,16 @@ {html_checkboxes} + + {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. + + @@ -71,15 +81,7 @@ - - {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. diff --git a/docs/en/designers/language-custom-functions/language-function-html-image.xml b/docs/en/designers/language-custom-functions/language-function-html-image.xml index 9347187a..bc1c692f 100644 --- a/docs/en/designers/language-custom-functions/language-function-html-image.xml +++ b/docs/en/designers/language-custom-functions/language-function-html-image.xml @@ -2,6 +2,14 @@ {html_image} + + {html_image} is a + custom function + that generates an HTML tag for an + image. The height and width are automatically calculated from the + image file if none are supplied. + + @@ -64,13 +72,7 @@ - - {html_image} is a - custom function - that generates an HTML tag for an - image. The height and width are automatically calculated from the - image file if none are supplied. - + basedir is the base directory that relative image paths are based from. If not given, the web server document root ( diff --git a/docs/en/designers/language-custom-functions/language-function-html-options.xml b/docs/en/designers/language-custom-functions/language-function-html-options.xml index 674fdb1e..dd0d1e6a 100644 --- a/docs/en/designers/language-custom-functions/language-function-html-options.xml +++ b/docs/en/designers/language-custom-functions/language-function-html-options.xml @@ -2,6 +2,15 @@ {html_options} + + {html_options} is a + custom function + that creates html <select><option> 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. + + @@ -57,14 +66,7 @@ - - {html_options} is a - custom function - that creates html <select><option> 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. - + If a given value is an array, it will treat it as an html <optgroup>, and display the groups. Recursion is supported with <optgroup>. All diff --git a/docs/en/designers/language-custom-functions/language-function-html-radios.xml b/docs/en/designers/language-custom-functions/language-function-html-radios.xml index 9eb4ea10..6f223145 100644 --- a/docs/en/designers/language-custom-functions/language-function-html-radios.xml +++ b/docs/en/designers/language-custom-functions/language-function-html-radios.xml @@ -2,6 +2,15 @@ {html_radios} + + {html_radios} is a + custom function + that creates html radio button + group with provided data. It takes care of which item is selected + by default as well. Required attributes are values and output, + unless you use options instead. All output is XHTML compatible. + + @@ -64,14 +73,7 @@ - - {html_radios} is a - custom function - that creates html radio button - group with provided data. It takes care of which item is 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. diff --git a/docs/en/designers/language-custom-functions/language-function-html-select-date.xml b/docs/en/designers/language-custom-functions/language-function-html-select-date.xml index fc296971..d456770e 100644 --- a/docs/en/designers/language-custom-functions/language-function-html-select-date.xml +++ b/docs/en/designers/language-custom-functions/language-function-html-select-date.xml @@ -2,6 +2,13 @@ {html_select_date} + + {html_select_date} is a + custom function + that creates date dropdowns + for you. It can display any or all of year, month, and day. + + @@ -221,12 +228,7 @@ - - {html_select_date} is a - custom function - that creates date dropdowns - for you. It can display any or all of year, month, and day. - + {html_select_date} Template code diff --git a/docs/en/designers/language-custom-functions/language-function-html-select-time.xml b/docs/en/designers/language-custom-functions/language-function-html-select-time.xml index 531887af..b3b432c0 100644 --- a/docs/en/designers/language-custom-functions/language-function-html-select-time.xml +++ b/docs/en/designers/language-custom-functions/language-function-html-select-time.xml @@ -2,6 +2,13 @@ {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. + + @@ -132,12 +139,7 @@ - - {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 unique timestamp, a diff --git a/docs/en/designers/language-custom-functions/language-function-html-table.xml b/docs/en/designers/language-custom-functions/language-function-html-table.xml index fa60cdaa..373caeed 100644 --- a/docs/en/designers/language-custom-functions/language-function-html-table.xml +++ b/docs/en/designers/language-custom-functions/language-function-html-table.xml @@ -2,6 +2,19 @@ {html_table} + + {html_table} is a + custom function + that dumps an array of + data into an HTML table. The cols attribute determines + how many columns will be in the table. The table_attr, + tr_attr and td_attr values + determine the attributes given to the table, tr and td tags. If + tr_attr or td_attr are arrays, + they will be cycled through. trailpad is the value put + into the trailing cells on the last table row if there are any present. + + @@ -116,18 +129,7 @@ - - {html_table} is a - custom function - that dumps an array of - data into an HTML table. The cols attribute determines - how many columns will be in the table. The table_attr, - tr_attr and td_attr values - determine the attributes given to the table, tr and td tags. If - tr_attr or td_attr are arrays, - they will be cycled through. trailpad is the value put - into the trailing cells on the last table row if there are any present. - + html_table diff --git a/docs/en/designers/language-custom-functions/language-function-mailto.xml b/docs/en/designers/language-custom-functions/language-function-mailto.xml index d81c5f12..6438bb3d 100644 --- a/docs/en/designers/language-custom-functions/language-function-mailto.xml +++ b/docs/en/designers/language-custom-functions/language-function-mailto.xml @@ -2,6 +2,12 @@ {mailto} + + {mailto} automates the creation of mailto: links and optionally + encodes them. Encoding e-mails makes it more difficult for + web spiders to lift e-mail addresses off of your site. + + @@ -90,11 +96,7 @@ - - {mailto} automates the creation of mailto: links and optionally - encodes them. Encoding e-mails makes it more difficult for - web spiders to lift e-mail addresses off of your site. - + Technical Note diff --git a/docs/en/designers/language-custom-functions/language-function-math.xml b/docs/en/designers/language-custom-functions/language-function-math.xml index 25321c93..1feaacec 100644 --- a/docs/en/designers/language-custom-functions/language-function-math.xml +++ b/docs/en/designers/language-custom-functions/language-function-math.xml @@ -2,6 +2,22 @@ {math} + + {math} allows the template designer to do math equations in the + template. Any numeric template variables may be used in the + equations, and the result is printed in place of the tag. The + variables used in the equation are passed as parameters, which can + be template variables or static values. +, -, /, *, abs, ceil, cos, + exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, + srans and tan are all valid operators. Check the PHP documentation + for further information on these math functions. + + + If you supply the special "assign" attribute, the output of the + math function will be assigned to this template variable instead of + being output to the template. + + @@ -57,21 +73,7 @@ - - {math} allows the template designer to do math equations in the - template. Any numeric template variables may be used in the - equations, and the result is printed in place of the tag. The - variables used in the equation are passed as parameters, which can - be template variables or static values. +, -, /, *, abs, ceil, cos, - exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, - srans and tan are all valid operators. Check the PHP documentation - for further information on these math functions. - - - If you supply the special "assign" attribute, the output of the - math function will be assigned to this template variable instead of - being output to the template. - + Technical Note diff --git a/docs/en/designers/language-custom-functions/language-function-popup-init.xml b/docs/en/designers/language-custom-functions/language-function-popup-init.xml index a411add1..b0e22327 100644 --- a/docs/en/designers/language-custom-functions/language-function-popup-init.xml +++ b/docs/en/designers/language-custom-functions/language-function-popup-init.xml @@ -10,23 +10,20 @@ 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 + was written by Erik Bosrup, and the homepage/download is located at &url.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_init must be called once at the top of the page *} -{popup_init src="/javascripts/overlib.js"} +{popup_init src="javascripts/overlib.js"} ]]> diff --git a/docs/en/designers/language-custom-functions/language-function-popup.xml b/docs/en/designers/language-custom-functions/language-function-popup.xml index cac28100..3f955d1e 100644 --- a/docs/en/designers/language-custom-functions/language-function-popup.xml +++ b/docs/en/designers/language-custom-functions/language-function-popup.xml @@ -2,6 +2,12 @@ {popup} + + {popup} is used to create javascript popup windows. + {popup_init} MUST be called first for + this to work. + + @@ -390,11 +396,7 @@ - - {popup} is used to create javascript popup windows. - {popup_init} MUST be called first for - this to work. - + {popup} diff --git a/docs/en/designers/language-custom-functions/language-function-textformat.xml b/docs/en/designers/language-custom-functions/language-function-textformat.xml index 5a2b04c3..58735858 100644 --- a/docs/en/designers/language-custom-functions/language-function-textformat.xml +++ b/docs/en/designers/language-custom-functions/language-function-textformat.xml @@ -2,6 +2,18 @@ {textformat} + + {textformat} is a + block function + used to format text. It basically + cleans up spaces and special characters, and formats paragraphs by + wrapping at a boundary and indenting lines. + + + You can set the parameters explicitly, or use a preset style. + Currently "email" is the only available style. + + @@ -81,17 +93,7 @@ - - {textformat} is a - block function - used to format text. It basically - cleans up spaces and special characters, and formats paragraphs by - wrapping at a boundary and indenting lines. - - - You can set the parameters explicitly, or use a preset style. - Currently "email" is the only available style. - + {textformat}