diff options
Diffstat (limited to 'libs/plugins/function.html_image.php')
| -rw-r--r-- | libs/plugins/function.html_image.php | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/libs/plugins/function.html_image.php b/libs/plugins/function.html_image.php index f148f1c3..2f1ef641 100644 --- a/libs/plugins/function.html_image.php +++ b/libs/plugins/function.html_image.php @@ -13,23 +13,24 @@ * Name: html_image<br> * Date: Feb 24, 2003<br> * Purpose: format HTML tags for the image<br> - * Examples: {html_image file="/images/masthead.gif"} - * Output: <img src="/images/masthead.gif" width=400 height=23> + * Examples: {html_image file="/images/masthead.gif"}<br> + * Output: <img src="/images/masthead.gif" width=400 height=23><br> + * Params: + * <pre> + * - file - (required) - file (and path) of image + * - height - (optional) - image height (default actual height) + * - width - (optional) - image width (default actual width) + * - basedir - (optional) - base directory for absolute paths, default is environment variable DOCUMENT_ROOT + * - path_prefix - prefix for path output (optional, default empty) + * </pre> * - * @link http://smarty.php.net/manual/en/language.function.html.image.php {html_image} + * @link http://www.smarty.net/manual/en/language.function.html.image.php {html_image} * (Smarty online manual) * @author Monte Ohrt <monte at ohrt dot com> * @author credits to Duda <duda@big.hu> * @version 1.0 - * @param array $params parameters - * Input:<br> - * - file = file (and path) of image (required) - * - height = image height (optional, default actual height) - * - width = image width (optional, default actual width) - * - basedir = base directory for absolute paths, default - * is environment variable DOCUMENT_ROOT - * - path_prefix = prefix for path output (optional, default empty) - * @param object $template template object + * @param array $params parameters + * @param Smarty_Internal_Template $template template object * @return string * @uses smarty_function_escape_special_chars() */ |