substitution

Substitution string element. Optional in <rule> elements.

Attributes

None.

Data

Substitution string.

Description

Defines a replacement string for the matched string or substring in the path or query.

If the pattern expression includes sub-expressions (delimited with parentheses), the first matched substring is replaced with the substitution string. If the pattern expression does not include sub-expressions, the entire matched string is substituted.

If <expression> is empty or absent, the substitution string is appended to the path or query.

If <substitution> is empty, the matched string or substring is removed. If <substitution> is not specified, the path or query string is not modified.

NOTE

All matches in the input string are substituted when replace="all" is specified in the <rule>,element to which this <substitution> element belongs. By default, only the first match is replaced with the substitution string.

Note

The substitution string must not contain literal < and & characters. These reserved characters can be encoded with & and <, respectively, or the entire string can be enclosed in an XML CDATA section:

<substitution><![CDATA[&text=<Hello, world!>]]></ substitution>