24 lines
1.7 KiB
Plaintext
24 lines
1.7 KiB
Plaintext
|
%META:TOPICINFO{author="TWikiContributor" date="1167874036" format="1.2" version="2"}%
|
||
|
|
%META:TOPICPARENT{name="TWikiVariables"}%
|
||
|
|
#VarENCODE
|
||
|
|
|
||
|
|
---+++ ENCODE{"string"} -- encodes a string to HTML entities
|
||
|
|
* Encode "special" characters to HTML numeric entities. Encoded characters are:
|
||
|
|
* all non-printable ASCII characters below space, except newline (="\n"=) and linefeed (="\r"=)
|
||
|
|
* HTML special characters ="<"=, =">"=, ="&"=, single quote (='=) and double quote (="=)
|
||
|
|
* TWiki special characters ="%"=, ="["=, ="]"=, ="@"=, ="_"=, ="*"=, ="="= and ="|"=
|
||
|
|
* Syntax: =%<nop>ENCODE{"string"}%=
|
||
|
|
* Supported parameters:
|
||
|
|
| *Parameter:* | *Description:* | *Default:* |
|
||
|
|
| ="string"= | String to encode | required (can be empty) |
|
||
|
|
| =type="entity"= | Encode special characters into HTML entities, like a double quote into =&#034;=. Does *not* encode =\n= or =\r=. | =type="url"= |
|
||
|
|
| =type="html"= | As =type="entity"= except it also encodes =\n= and =\r= | =type="url"= |
|
||
|
|
| =type="quote"= | Escape double quotes with backslashes (=\"=), does not change other characters | =type="url"= |
|
||
|
|
| =type="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | (this is the default) |
|
||
|
|
* Example: =%<nop>ENCODE{"spaced name"}%= expands to =%ENCODE{"spaced name"}%=
|
||
|
|
* __%X% Note:__ Values of HTML input fields must be entity encoded.%BR% Example: =<input type="text" name="address" value="%<nop>ENCODE{ "any text" type="entity" }%" />=
|
||
|
|
* __%X% Note:__ Double quotes in strings must be escaped when passed into other TWiki variables.%BR% Example: =%<nop>SEARCH{ "%<nop>ENCODE{ "string with "quotes"" type="quotes" }%" noheader="on" }%=
|
||
|
|
|
||
|
|
* Related: [[#VarURLPARAM][URLPARAM]]
|
||
|
|
|