User Tools

Site Tools


manual:Tokens

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Next revision Both sides next revision
manual:Tokens [2016/06/27 02:43]
peternlewis created
manual:Tokens [2019/06/17 03:25]
peternlewis
Line 1: Line 1:
 ====== Tokens ====== ====== Tokens ======
  
-Tokens allow you to add textual information to [[/​Text_Fields|token text fields]]. ​ You can insert tokens into a field using the Insert Token popup near the field or by choosing [[Menus#​Edit_Insert_Token|Insert Token]] from the [[Menus#​Edit|Edit ​menu]]. ​ You can also start typing a token and use type completion to complete the token.+Tokens allow you to add textual information to [[/​Text_Fields|token text fields]].  ​You can tell that a field accepts tokens because a small BUTTON{{{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 [[Menus#​Edit_Insert_Token|Edit ➤ Insert Token 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 [[Menus#​Insert_Token_by_Name|Edit ➤ Insert Token by Name menu]].
  
 The available tokens are listed on the [[/​Tokens|wiki Tokens page]]. The available tokens are listed on the [[/​Tokens|wiki Tokens page]].
Line 8: Line 10:
  
 To include a percent in your text, simply double the percent (%%). To include a backslash \ in your text, double the backslash (\\). 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:
 +
 +* [[token:​TriggerValue|TriggerValue]]
 +* [[token:​WindowFrame|FrontWindow*]]
 +* [[token:​WindowFrame|Window*]]
 +* [[token:​Screen|Screen*]]
 +* [[token:​SystemClipboard|SystemClipboard]]
 +* [[token:​PastClipboard|PastClipboard]]
 +* [[token:​NamedClipboard|NamedClipboard]]
 +* [[token:​TriggerClipboard|TriggerClipboard]]
 +* [[token:​CurrentMouse|CurrentMouse]]
 +* [[token:​FoundImage|FoundImage]]
 +
 +Many actions allow you to turn off tokens or backslash character processing if you need to use text that has percent or backslash characters. ​ You can control this by clicking the BUTTON{{{⚙}}} button and using the action menu.
  
manual/Tokens.txt · Last modified: 2023/10/02 00:10 by peternlewis