Changeset 24922

Timestamp:

11/29/08 15:23:36 (6 weeks ago)

Author:

Landseer

Message:

updated docs, this closes #378

Files:

• development/main/system/pnRender/plugins/insert.setpagevar.php (modified) (3 diffs)

development/main/system/pnRender/plugins/insert.setpagevar.php

@@ -5 +5 @@
  * @copyright (c) 2008, Zikula Development Team
  * @link http://www.zikula.org
- * @version $Id: $
+ * @version $Id$
  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
  * @package Zikula_Template_Plugins
@@ -12 +12 @@
 
 /**
- * Smarty function to set page variable
+ * Smarty function to set a single value page variable
  *
- * This function sets a page-specific variable from the Zikula system.
+ * This function sets a page-specific variable from the Zikula system. Only single value pagevars are supported by
+ * this insert!
  *
  * Available parameters:
- *   - var:     The name of the page variable to set
+ *   - var:     The name of the single value page variable to set
  *   - value:    The value of the page variable to set
  *
- * Zikula doesn't impose any restriction on the page variabl's name except for duplicate
- * and reserved names. As of this writing, the list of reserved names consists of
+ * Zikula doesn't impose any restriction on the page variable's name except for duplicate
+ * and reserved names. As of this writing, the list of supported names consists of
  * <ul>
  * <li>title</li>
  * <li>description</li>
- * <li>keywords</li>
- * <li>stylesheet</li>
- * <li>javascript</li>
- * <li>body</li>
- * <li>rawtext</li>
- * <li>footer</li>
  * </ul>
  *
@@ -42 +37 @@
  * @param        object      &$smarty     Reference to the Smarty object
  * @param        string      $var         Name of the page variable to set
- * @param        string      $value        Value of  he page variable to set
+ * @param        string      $value       Value of  he page variable to set
  */
 function smarty_insert_setpagevar($params, &$smarty)