User Tools

Site Tools


manual:Tokens

Tokens

Tokens allow you to add textual information to token text fields. You can tell that a field accepts tokens because a small T shows in the field while editing it.

You can insert tokens into a field using the Insert Token popup near the field or by choosing Insert Token from the Edit menu. You can also start typing a token and use type completion to complete the token. You can insert a token by name by choosing Insert Token by Name from the Edit menu.

The available tokens are listed on the wiki Tokens page.

Text token fields also process %NN% or %NNNN% as arbitrary hex unicode characters (eg %41% is an A), and (except for regular expression fields) process backslashed characters \a,\b,\e,\f,\t,\r,\n (bell,backspace,escape,form feed,tab,return,line feed).

To include a percent in your text, simply double the percent (%%). To include a backslash \ in your text, double the backslash (\\).

With tokens that commonly contain arrays of information, you can easily access the individual parts using the token array notation, eg %TriggerValue[3]% will be the third comma-separated value, and %TriggerValue[3];% will be the third semicolon-separated value, and %TriggerValue[3] % (note the space between the ] and the %) will be the third space-separated value (8.0.4+). This currently works with the following tokens:

Many actions allow you to turn off tokens or backslash character processing if you need to use text that has percent or backslash characters.

manual/Tokens.txt · Last modified: 2017/11/06 01:39 by peternlewis