• This web contains the official documentation of the
TWiki Release 4.0.2, code named
DakarRelease. It is a read-only web for reference.
• This is an older release, see
TWiki-6.1 for the latest release documentation.
URLPARAM{"name"} -- get value of a URL parameter
- Returns the value of a URL parameter.
- Syntax:
%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="<br />" | Convert newlines in textarea to other delimiters | no conversion |
encode="entity" | Encode special characters into HTML entities. See ENCODE for more details. | no encoding |
encode="url" | Encode special characters for URL parameter use, like a double quote into %22 | no encoding |
multiple="on" multiple="[[$item]]" | If set, gets all selected elements of a <select multiple="multiple"> 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:
%URLPARAM{"skin"}%
returns print
for a .../view/TWiki04/VarURLPARAM?skin=print
URL
- Note: URL parameters passed into HTML form fields must be entity ENCODEd
- Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.
- Note: There is a risk that this variable could be misused for cross-site scripting.
- Related: ENCODE, SEARCH, FormattedSearch, QUERYSTRING
USERINFO - retrieve details about the logged in user
- By default, the retrieved info will be formatted as a comma-separated list comprising the username, wikiusername, and emails.
- Syntax:
%USERINFO%
- Expands to: =guest, TWikiGuest, =
- you can also use the
format
parameter to get different formatted results:
- Syntax:
%USERINFO{format="$username is really $wikiname"}%
- Expands to
guest is really TWikiGuest
- The tokens
$emails
, $username
, $wikiname
, $wikiusername
, and $groups
are available for use in the format string.
- Related: USERNAME, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication, ChangeEmailAddress