User Tools

Site Tools


manual:Plug_In_Actions

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:Plug_In_Actions [2021/06/01 23:58]
JMichaelTX [Plist Parameters]
manual:Plug_In_Actions [2021/06/02 00:19]
JMichaelTX [How To Use a PIA]
Line 29: Line 29:
 To insert a PIA into your Macro, use any of the normal methods to insert Actions: To insert a PIA into your Macro, use any of the normal methods to insert Actions:
   - Display the _Actions Panel_ from the menu or with the shortcut ⌘K, and select the _Third Party Plugins_ folder:   - Display the _Actions Panel_ from the menu or with the shortcut ⌘K, and select the _Third Party Plugins_ folder:
-    * {{ :​manual:​plugin-folder-in-action-panel.png?​nolink |}} +    * {{:​manual:​plugin-folder-in-action-panel.png?​nolink|}} ​
   - Menu _Edit > Actions > Third Party Plugins_   - Menu _Edit > Actions > Third Party Plugins_
   - _Insert Action by Name_, using shortcut ⌘⌃A.   - _Insert Action by Name_, using shortcut ⌘⌃A.
Line 74: Line 74:
  
 ^ Key ^ Description ^ ^ Key ^ Description ^
-^ Name | Name of the action.\\ (which appears in the Category/​Actions list) | +^ Name | **Name of the action**.\\ (which appears in the Category/​Actions list) | 
-^ Script | Name of the script file which will be run when the PIA is executed.\\ ​ The name can only use ASCII alphanumerics or underscores,​ plus an ASCII alphanumeric extension | +^ Script | **Name of the script file** which will be run when the PIA is executed.\\ ​ The name can only use ASCII alphanumerics or underscores,​ plus an ASCII alphanumeric extension | 
-^ Parameters | An array of parameters to the script, each entry is a dictionary [[Plug_In_Actions#​Plist_Parameters|as described below]].\\  These parameters will appear as form fields in the PIA in the Keyboard Maestro Editor.\\ They allow the user of the PIA to enter the data to be processed by the script. ​\\ **Optional** | +^ Parameters | **An array of parameters to the script**<​WRAP>​ 
-^ Icon | Name of the icon png file, made up of only ASCII alphanumerics or underscores plus .png \\ **Optional** | +  * Each entry is a dictionary [[Plug_In_Actions#​Plist_Parameters|as described below]]. 
-^ Title | The title displayed on the action, which can include %Param%XYZ% tokens.\\ It should usually not include other tokens.\\ If it is missing, the Name will be used \\ **Optional** | +  These parameters will appear as form fields in the PIA in the Keyboard Maestro Editor. 
-^ Timeout | The default timeout in seconds, entered ​as a _number_.\\ Set it to 0 if the action needs no timeout.\\  The default is 99 hours\\  Like all Actions, Timeout can be changed in the _Editor_.\\ **Optional** |+  * They allow the user of the PIA to enter the data to be processed by the script. 
 +  *  ​**Optional** 
 +</​WRAP> ​
 +^ Icon | **Name of the icon png file**, made up of only ASCII alphanumerics or underscores plus .png \\ **Optional** | 
 +^ Title | **The title displayed on the action**<​WRAP>​ 
 +  * Which can include %Param%XYZ% tokens. 
 +  * It should usually not include other tokens. 
 +  * If it is missing, the Name will be used
 +  * **Optional** 
 +</​WRAP> ​
 +^ Timeout | **The default timeout in seconds**<​WRAP>​ 
 +  * Entered ​as a _number_ 
 +  * Set it to 0 if the action needs no timeout 
 +  The default is 99 hours 
 +  Like all Actions, Timeout can be changed in the _Editor_ 
 +  * **Optional** 
 +</​WRAP> ​|
 ^ Author | The author of this action \\ **Optional** | ^ Author | The author of this action \\ **Optional** |
 ^ URL | URL for the author or this action \\ **Optional** | ^ URL | URL for the author or this action \\ **Optional** |
 ^ Help | A short (Tool Tip) explanation of this action \\ **Optional** | ^ Help | A short (Tool Tip) explanation of this action \\ **Optional** |
-^ Results | What to do with the output of the script if any.\\ Possible Values: NoneWindowBrieflyTypingPastingVariableClipboard ​– multiple ​values can be used, separated by a bar (%%|%%), the first specified value is the default \\ **Optional** |+^ Results | **What to do with the output of the script if any**.\\ Possible Values:<​WRAP>​ 
 +  * None 
 +  * Window 
 +  * Briefly 
 +  * Typing 
 +  * Pasting 
 +  * Variable 
 +  * Clipboard 
 +</​WRAP>​ Multiple ​values can be used, separated by a bar (%%|%%), the first specified value is the default \\ **Optional** |
  
 ==== Plist Parameters ==== ==== Plist Parameters ====
manual/Plug_In_Actions.txt · Last modified: 2021/06/02 00:19 by JMichaelTX