Formatting Tokens

TWiki defines some standard special tokens that can be used to replace characters in some parameters - notably those to FormattedSearch and IfStatements - to defer evaluation of the parameter until later. These special tokens are often called "escapes", because they allow the character to "escape" from its normal meaning.

$n or $n() New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar

$nop or $nop() Is a "no operation". This variable gets removed; useful for nested search

$quot or \" Double quote (")

$aquot Apostrophe quote (')

$percnt Percent sign (%)

$dollar Dollar sign ($)

$lt Less than sign (<)

$gt Greater than sign (>)

`$n` or `$n()`	New line. Use `$n()` if followed by alphanumeric character, e.g. write `Foo$n()Bar` instead of `Foo$nBar`
`$nop` or `$nop()`	Is a "no operation". This variable gets removed; useful for nested search
`$quot` or `\"`	Double quote (`"`)
`$aquot`	Apostrophe quote (`'`)
`$percnt`	Percent sign (`%`)
`$dollar`	Dollar sign (`$`)
`$lt`	Less than sign (`<`)
`$gt`	Greater than sign (`>`)

If you ever find yourself needing to escape an escape, you can use $dollar to escape the leading dollar, thus: $dollarpercnt.

Related topics: FormattedSearch, IfStatements, QuerySearch, TWikiForms

Revision r5 - 2013-08-22 - 00:48:15 - TWikiContributor Edit