You are here: addons4webgui > Home > Macros
User: Visitor
Navigation
News
Login
Param

Documentation

Param Macro for WebGUI

What's this?:

This WebGUI macro returns various parameters from the methods POST (forms) and GET (query string in the URL).
If the parameter is not available on POST or GET, the parameter gets the specified default value.

System requirements:

  • Web server (tested on Apache 2).
  • WebGUI (tested on WebGUI V7.4.x).

Files:

  • WebGUI/docs/Macro_Param.html: This document here.
  • WebGUI/lib/WebGUI/Help/Macro_Param.pm: Help file.
  • WebGUI/lib/WebGUI/Macro/Param.pm: WebGUI macro.
  • WebGUI/lib/WebGUI/i18n/English/Macro_Param.pm: Texts in english language.
  • WebGUI/lib/WebGUI/i18n/German/Macro_Param.pm: Texts in german language.

Installation:

  1. Download the package source from http://sourceforge.net/projects/addons4webgui.
  2. Extract it into your WebGUI install. Example: tar xvfz /path/to/Macro_Param-x.x.x.tar.gz /path/to/WebGUI.
  3. Edit WebGUI.conf file to add the Param macro to the macro list.
  4. Restart web server.

Important notes:

  • On the page where the macro is inserted, set the cache timeout and the cache timeout (visitor) to zero!!!

Usage:

ˆParam([parameter],[default value]);

Example: ˆParam(width,300);

Troubleshooting:

See web server log file and/or webgui log file.

Changelog:

V3.0.1:
  • Renamed and updated this document
V3.0.0:
  • Migrated to WebGUI V7.4.x
V2.1.0:
  • Migrated to WebGUI V6.8.x
  • Added text files
  • Added help file
V2.0.0:
  • Testet with WebGUI 6.7.x
  • Added this doc
V0.1.0:
  • First release
Copyright 2006-2008, studio4master
Licensed under the GNU General Public License (GPL) V3

http://addons4webgui.studio4master.ch

            Valid CSS!  
Running on WebGUI 7.6.25-s4m-20090617
Copyright (c) 2001-2009 by studio4master