head	1.5;
access;
symbols;
locks; strict;
comment	@# @;


1.5
date	2008.12.06.09.02.09;	author TWikiContributor;	state Exp;
branches;
next	1.4;

1.4
date	2008.08.03.22.17.49;	author TWikiContributor;	state Exp;
branches;
next	1.3;

1.3
date	2008.01.22.03.21.32;	author TWikiContributor;	state Exp;
branches;
next	1.2;

1.2
date	2007.01.16.04.12.00;	author TWikiContributor;	state Exp;
branches;
next	1.1;

1.1
date	2006.06.25.16.26.29;	author TWikiContributor;	state Exp;
branches;
next	;


desc
@buildrelease
@


1.5
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1228163901" format="1.1" version="5"}%
%META:TOPICPARENT{name="TWikiVariables"}%
#VarURLPARAM
---+++ URLPARAM{"name"} -- get value of a URL parameter
   * Returns the value of a URL parameter.
   * Syntax: =%<nop>URLPARAM{"name"}%=
   * Supported parameters:
     | *Parameter:* | *Description:* | *Default:* |
     | ="name"= | The name of a URL parameter | required |
     | =default="..."= | Default value in case parameter is empty or missing | empty string |
     | =newline="&lt;br /&gt;"= | Convert newlines in textarea to other delimiters | no conversion |
     | =encode="entity"= | Encode special characters into HTML entities. See [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarENCODE][ENCODE]] for more details. | no encoding |
     | =encode="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | no encoding |
     | =encode="quote"= | Escape double quotes with backslashes (=\"=), does not change other characters; required when feeding URL parameters into other TWiki variables | no encoding |
     | =multiple="on"= %BR% =multiple="[<nop>[$item]]"= | If set, gets all selected elements of a =&lt;select multiple="multiple"&gt;= tag. A format can be specified, with =$item= indicating the element, e.g. =multiple="Option: $item"= | first element |
     | =separator=", "= | Separator between multiple selections. Only relevant if multiple is specified | ="\n"= (new line) |
   * Example: =%<nop>URLPARAM{"skin"}%= returns =print= for a =.../view/%WEB%/%INCLUDINGTOPIC%?skin=print= URL
   * __%X% Notes:__
      * *IMPORTANT:* There is a risk that this variable could be misused for [[http://en.wikipedia.org/wiki/Cross-site_scripting][cross-site scripting]] (XSS).
      * URL parameters passed into HTML form fields __must be__ entity [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarENCODE][ENCODEd]].%BR% Example: =&lt;input type="text" name="address" value="%<nop>URLPARAM{ "address" encode="entity" }%" /&gt;=
      * Double quotes in URL parameters must be escaped when passed into other TWiki variables.%BR% Example: =%<nop>SEARCH{ "%<nop>URLPARAM{ "search" encode="quotes" }%" noheader="on" }%=
      * When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
      * Watch out for TWiki internal parameters, such as =rev=, =skin=, =template=, =topic=, =web=; they have a special meaning in TWiki. Common parameters and view script specific parameters are documented at TWikiScripts.
      * If you have =%<nop>URLPARAM{= in the value of a URL parameter, it will be modified to =%&lt;nop&gt;URLPARAM{=. This is to prevent an infinite loop during expansion.
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarENCODE][ENCODE]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSEARCH][SEARCH]], FormattedSearch, [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarQUERYSTRING][QUERYSTRING]]
@


1.4
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1210720545" format="1.1" version="4"}%
d19 2
a20 1
      * URL parameters passed into HTML form fields must be entity [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarENCODE][ENCODEd]].
a24 1
      * There is a risk that this variable could be misused for cross-site scripting.
@


1.3
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1167874036" format="1.1" version="3"}%
d18 7
a24 4
   * __%X% Note:__ URL parameters passed into HTML form fields must be entity [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarENCODE][ENCODEd]].
   * __%X% Note:__ Double quotes in URL parameters must be escaped when passed into other TWiki variables.%BR% Example: =%<nop>SEARCH{ "%<nop>URLPARAM{ "search" encode="quotes" }%" noheader="on" }%=
   * __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
   * __%X% Note:__ There is a risk that this variable could be misused for cross-site scripting.
a25 2

__Note__ If you have =%<nop>URLPARAM{= in the value of a URL parameter, it will be modified to =%&lt;nop&gt;URLPARAM{=. This is to prevent an infinite loop during expansion.@


1.2
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1167874036" format="1.2" version="2"}%
a3 1

d12 1
a12 1
     | =encode="entity"= | Encode special characters into HTML entities. See [[#VarENCODE][ENCODE]] for more details. | no encoding |
d18 1
a18 1
   * __%X% Note:__ URL parameters passed into HTML form fields must be entity [[#VarENCODE][ENCODEd]].
d22 3
a24 1
   * Related: [[#VarENCODE][ENCODE]], [[#VarSEARCH][SEARCH]], FormattedSearch, [[#VarQUERYSTRING][QUERYSTRING]]
@


1.1
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="1"}%
d15 1
d19 2
a20 1
   * __%X% Note:__ URL parameters passed into HTML form fields must be entity [[#VarENCODE][ENCODEd]]
@
