TWiki/FormatTokens.mdwn

   1 ## <a name="Formatting Tokens"></a> Formatting Tokens
   2
   3 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.
   4
   5 <table border="1" cellpadding="0" cellspacing="0">
   6   <tr>
   7     <td><code>$n</code> or <code>$n()</code></td>
   8     <td> New line. Use <code>$n()</code> if followed by alphanumeric character, e.g. write <code>Foo$n()Bar</code> instead of <code>Foo$nBar</code></td>
   9   </tr>
  10   <tr>
  11     <td><code>$nop</code> or <code>$nop()</code></td>
  12     <td> Is a "no operation". This variable gets removed; useful for nested search </td>
  13   </tr>
  14   <tr>
  15     <td><code>$quot</code></td>
  16     <td> Double quote (<code>"</code>) (\" also works) </td>
  17   </tr>
  18   <tr>
  19     <td><code>$percnt</code></td>
  20     <td> Percent sign (<code>%</code>) </td>
  21   </tr>
  22   <tr>
  23     <td><code>$dollar</code></td>
  24     <td> Dollar sign (<code>$</code>) </td>
  25   </tr>
  26 </table>
  27
  28 If you ever find yourself needing to escape an escape, you can use `$dollar` to escape the leading dollar, thus: `$dollarpercnt`.