User Tools
manual:Plug_In_Actions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
manual:Plug_In_Actions [2021/06/01 23:55] JMichaelTX Convert to List in Cell |
manual:Plug_In_Actions [2021/06/02 00:13] JMichaelTX [PIA PList] Convert to lists in table cells |
||
|---|---|---|---|
| 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: None, Window, Briefly, Typing, Pasting, Variable, Clipboard – 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 ==== | ||
| ^ Parameter Key ^ Description ^ | ^ Parameter Key ^ Description ^ | ||
| - | ^ Label | **Name of the parameter**.\\ The same rules as Keyboard Maestro Variable Names apply.\\ The label is displayed to the user and used to pass the parameter to the script.\\ Obviously, the label must be unique amongst all parameters | | + | ^ Label | **Name of the parameter**.<WRAP> |
| + | * The same rules as Keyboard Maestro Variable Names apply. | ||
| + | * The label is displayed to the user and used to pass the parameter to the script. | ||
| + | * Obviously, the label must be unique amongst all parameters | ||
| + | </WRAP> | | ||
| ^ Type | **Type of the parameter**.\\ Must be one of the following:\\ _(Text in italics is info, and not part of the Type)_<WRAP> | ^ Type | **Type of the parameter**.\\ Must be one of the following:\\ _(Text in italics is info, and not part of the Type)_<WRAP> | ||
| * String _(single line)_ | * String _(single line)_ | ||
manual/Plug_In_Actions.txt · Last modified: 2023/10/06 02:28 by peternlewis
Page Tools
