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/10/06 02:41]
peternlewis
manual:Plug_In_Actions [2023/10/06 02:28] (current)
peternlewis [Retrieving Parameters in a Script]
Line 53: Line 53:
  
  
-**A _Plug In Action_ is Contained in a Folder**,\\ **Whose Name:**+**A _Plug In Action_ is Contained in a Folder**, **Whose Name:**
   - Should generally closely match the action name   - Should generally closely match the action name
   - Must be made up of only ASCII alphanumerics,​ underscores and spaces.   - Must be made up of only ASCII alphanumerics,​ underscores and spaces.
Line 99: Line 99:
 ^ 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** |
 +^ HelpURL | A URL for the Help link for the action (v11.0+) \\ **Optional** |
 ^ Results | **What to do with the output of the script if any**.\\ Possible Values:<​WRAP>​ ^ Results | **What to do with the output of the script if any**.\\ Possible Values:<​WRAP>​
   * None   * None
   * Window   * Window
   * Briefly   * Briefly
 +  * Large
   * Typing   * Typing
   * Pasting   * Pasting
   * Variable   * Variable
 +  * AppendVar
   * Clipboard   * Clipboard
-</​WRAP>​ Multiple values can be used, separated by a bar (%%|%%), the first specified value is the default \\ **Optional** |+  * File 
 +  * Asynchronously 
 +</​WRAP>​ Multiple values can be used, separated by a bar (%%|%%), the first specified value is the default. If output is going to a clipboard or a file, the results can be an image. ​\\ **Optional** |
  
 ==== Plist Parameters ==== ==== Plist Parameters ====
Line 139: Line 144:
  
  
-_Parameters_ are passed to the script via _environment variables_ with names starting with KMPARAM‗, similar to how variables are passed to shell scripts with the Execute Script action. ​ +_Parameters_ are passed to the script via _environment variables_ with names starting with KMPARAM‗, similar to how variables are passed to shell scripts with the Execute Script action.
  
-So a parameter named "My Text" would be in an environment variable KMPARAM‗My‗Text.\\ +So a parameter named "My Text" would be in an environment variable KMPARAM‗My‗Text. Note that `spaces` in the variable names _must_ be replaced with `underscores` in your script.  ​
-Note that `spaces` in the variable names _must_ be replaced with `underscores` in your script.  ​+
  
  
manual/Plug_In_Actions.1633502475.txt.gz · Last modified: 2021/10/06 02:41 by peternlewis