Differences

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

--- action:Prompt_for_User_Input [2016/11/24 22:39]
JMichaelTX [Buttons]
+++ action:Prompt_for_User_Input [2023/08/20 22:25]
peternlewis [Slider Field]
@@ Line 1: / Line 1: @@
-{{:action:form-icon.png?nolink |}}
+====== Prompt For User Input Action ======
-====== Prompt For User Input ======
-Prompt For User Input allows you to ask for user input, storing any results in variables. If the variable is a password variable (ie, its name starts or ends with “Password” or “PW”), it will be displayed in a password field.
+_Prompt For User Input_ allows you to design a form that will ask for user input, storing the results in [[manual:Variables|Keyboard Maestro Variables]].
-FIXME -- This article is currently incomplete.  It is in the middle of a major rewrite (@JMichaelTX).  I'll finish within the next day (2016-11-24).
+You can prompt for variables with text, checkbox, popup menu, or password fields.
-===== Example =====
+{{ promptaction.png?nolink&600 | Prompt For User InputAction }}
-**This Setup of the Prompt for User Action . . .**
+This action produces this Display:
-{{:action:promptaction.png|}}
+{{ promptwindow.png?nolink&583 | Prompt For User Input Window }}
-**Produces this Display***
+===== Form Fields =====
-{{:action:promptwindow.png|}}
+The _Prompt for User Input_ form (hereafter called "form") provides form fields for the following:
-===== Popup Menu -- How To Create =====
+^Field^Type^Purpose/Use^
+|Form Title|Display Only|Identify the Main Purpose of the Form|
+|Prompt|Display only|Optionally provide instructions and/or display Variables|
+|Keyboard Maestro Variables|Display/Edit|Optionally allow you to input variable values. Variables may be displayed as *Text* (Single Line, or Password), *Popup Menu*, or *Checkbox*, *Slider* (v10.0+), *Color* (v10.0+), Date or Time or Date&Time (v10.0+)|
+|Buttons|Standard Mac|Allow you to accept, cancel, or provide other responses you may define|
-Simply enter a default value with the Popup Choices separated by a bar (|), like this:\\
+==== Form Title ====
-“`Good|Better|Best`”
-* Then a popup menu will be used.
+The _Form Title_ is plain text, provided to communicate the basic purpose, or the name of the macro, to the user.
-* The first value in the list of choices will be assigned to the Variable, unless the user chooses a different Popup Choice.
+It may contain any of the Keyboard Maestro [[:Tokens|Tokens]].
-* You can assign a different default value for the Popup, by entering that value as the first choice listed.\\
+It is for display only, and cannot be changed by the user when the form is displayed.
-  * For example, if you would like "Better" to be the default Popup value, then use this:\\
-“`Better|Good|Better|Best`”
-==== Using a Variable for Popup Choices ====
+==== Prompt ====
-To use a Variable for the popup choices, see:
+The _Prompt_ is plain text, provided to provide instructions or data to the user.
-  * [Dynamic Default List for Prompt for User Input (Example)](https://forum.keyboardmaestro.com/t/dynamic-default-list-for-prompt-for-user-input-example/4441/1)
+It may contain any of the Keyboard Maestro [[:Tokens|Tokens]].
+It is for display only, and cannot be changed by the user when the form is displayed.
-==== Using a Dash ("`-`") to Separate Choices ====
+==== Variables ====
-If a popup menu item is a dash (-), then a separator is displayed. For example, “%%Good|Better|Best|-|Terrible%%”
-==== How to Store a Different Value than Displayed ====
+The Form may contain zero or more _Variable_ lines, with each line providing two form fields:
+  - [[manual:Variables|Keyboard Maestro Variable]] Name
+  - A default value for the _Variable_, which also implies the type of entry.
-Sometimes you may want to display a "friendly" value as the default value, but store a different value (like a code) in the actual Variable.  You can do this by using a prefix to the default value.
+Using the menu selection to the right of the default value (v10.0+), you can specify the type of the field:
-\\
+  * Automatic
-If a popup menu item starts with a prefix followed by two underscores, then the prefix will be used as the variable value, while the latter part will be displayed in the menu.
+  * Text
+  * Password
+  * Checkbox
+  * Menu
+  * Slider
+  * Color
+  * Date
+  * Date and Time
+  * Time
+  * Time with Seconds
-=== Example ===
+==== Automatic ====
-For example, \\
+Automatic type will guess the type based on the value of the default field - if it contains “|” bar separated fields, then it will be a menu, or a checkbox if all the values are 0 or 1, and if the variable is a Password variable (starts or ends with “Password” or “PW”), then a password field will be used.
-“%%B__Good|F__Fail|C__OK|B__Good|A__Excellent%%”\\
-would be shown as:\\
+==== Text Field ====
-```
-Fail
-OK
-Good  (selected by default)
-Excellent
-```
-==== How to Use a Variable for the Popup Choices ====
+The field will be displayed as a single line text input field.
-* Sometimes you might like to use a Keyboard Maestro Variable to store the list of Popup Choices, and then use this Variable in the Prompt for User Input Action.  This can be done simply starting the default value for the Popup with a vertical bar (`|`).\\
+The default field is a token text field.
-\\
-*If the Popup default value starts with a bar (|), then the Variable (which contains choices separated by `|`) will be expanded and evaluated before the Prompt is displayed, thus showing the choices from the Variable.
-Otherwise, the entry is separated by bar first, and then token expansion is applied to each field, so that fields may contain bars, for example, “This|That|%Variable%One Entry%”.
+==== Password Field ====
-===== A checkbox is used for 0 and 1 =====
+The field will be displayed as a single line password input field, displayed with bullets instead of characters.
-If the popup menu would contain only "0" and "1", then a checkbox is used (so for example, “0|1" or "1|0", depending on the desired default).
-===== How to Hide a Variable Prefix in the Prompt =====
+The default field is a token text field.
-It is a good idea to have a common prefix in all of the variables used by the same macro.  This clearly identifies the macro that uses these variables, and groups them together in the Variables section of the Keyboard Maestro Preferences.  But you may not want to expose this prefix to the user running the macro.\\
-**So, you can hide the prefix if the variable name starts with a prefix followed by two underscores**. Then the label will show only the latter part of the variable name.\\
+==== Checkbox ====
-For example:\\
+The field will be displayed as a checkbox. If the default value is “0”, or starts with “0|”, then the checkbox will default to off. If the default value is “1”, or starts with “1|”, the checkbox will default to on.
-If you enter "**`MyMacro__Text Message`**" in the variable name field of the Prompt for User Input action
-  * It will display a label of "**`Text Message`**":
-  * But will the actual variable name that is set will be just as you entered it: "**`MyMacro__Text Message`**"
-===== Buttons =====
+The default field is a token text field.
+==== Menu Field ====
+The field will be displayed as a popup menu.
+The default value defines the choices,  separated by a bar “|”, like: “Good|Better|Best”.
+The first value in the list of choices will be selected in the menu by default. For example, if you would like "Better" to be the default Popup value, then use “Better|Good|Better|Best”.
+If the menu item is a dash “-”, a menu separator will be used in its place. For example, “Good|Better|Best|-|Terrible”.
+If a menu items is separated in to two parts with two underscores (‗), then the first part is used as the result, while the second part is displayed in the menu. For example, “B‗‗Good|F‗‗Fail|C‗‗OK|B‗‗Good|A‗‗Excellent”.
+The default field is a token text field, so you can include variable options in your list, for example: “%Variable%First Choice%|%Variable%Second Choice%”. If you want to provide a list in a variable, then you do so by starting the field with a bar (“|”), followed by your list (or your default value and then your list) in a variable (which contains choices separated by `|`), for example “|%Variable%Current Choice%|%Variable%Choice List%”. Without the leading bar, the entry is separated by bar first, and then token expansion is applied to each field, so that fields may contain bars, for example, “This|That|%Variable%One Entry%”.
+==== Slider Field ====
+The field will be displayed as a slider.
+The default value defines the initial value and range of the slider. It can contain from zero to four comma-separated values, which are either:
+. initial value of 50, range 0-100.
+. initial value as specified, range 0-100.
+. range as specified, initial value half way between.
+. minimum, initial, maximum value as specified.
+. minimum, initial, maximum value as specified, and if the last value is greater than zero, the gap between allowed values, and if it is less than zero, the number of allowed values.
+For example, “0,50,100,10” means a range from 0 to 100, initial value of 50, and only valid values of 0, 10, 20, 30, … 90, 100.
+The result stored in the variable will be the value of the slider.
+This default value field is a calculation field.
+Up to Keyboard Maestro version 10.2, the result of the slider will always be an integer, and any initial value above 100 will be clipped to 100. Both of these limitations will be removed in a future version ([[https://forum.keyboardmaestro.com/t/slider-keeps-rounding-my-values-down/32936|forum]]).
+==== Color Field ====
+The field will be displayed as a color well.
+The default  value defines the color with three or four comma-separated values, being the red, green, blue and optional alpha values. All values have a range of 0 to 255.
+This default value field is a calculation field.
+==== Date and Time Fields ====
+The field will be displayed as a date, date & time, time, or time with seconds field.
+The default value is [[/unixtime|unixtime]] for the date and time. For time-only values, you can use either a unixtime or a time in seconds in the day (so 28,800 would be 8am) - either way the result will be in the same day as the specified default value.
+This default value field is a calculation field.
+==== Labels ====
+It can be a good idea to have a common prefix in all of the variables used by the same macro.  This clearly identifies the macro that uses these variables, and groups them together in the Variables section of the Keyboard Maestro Preferences.  But you may not want to expose this prefix to the user running the macro.
+So, you can hide the prefix if the variable name starts with a prefix followed by two underscores. Then the label will show only the latter part of the variable name.
+Similarly, you can use Instance or Local variables, and the “Instance” or “Local” will be removed from the variable name when displayed in the form.
+For example, variables named “MyMacro‗‗Text Message”, “Instance Text Message” or “Local Text Message” will all display the label “Text Message” in the form. The actual variable used will be the full variable name.
+==== Buttons ====
 By default, the _Prompt for User Input_ Action comes with two buttons:
-  - "`OK`"
+  - {{:action:km-7.3-ok-button.png?nolink|}}
     * Responds to shortcut <kbd>⏎</kbd> (RETURN)
-    * Closes the Prompt
+    * Closes the Prompt.
-    * Flows proceeds to next Action\\
+    * Flows proceeds to next Action.
-  - "`Cancel`"
+  - {{:action:km-7.3-cancel-button.png?nolink|}}
-    * Responds to shortcuts of
+    * Responds to shortcuts of either <key>⎋</key> (ESCAPE), or <key>⌘</key><key>.</key> (COMMAND-PERIOD)
-    * Closes the Prompt
+    * Closes the Prompt **without writing the variables**.
     * **Cancels the Macro**
+You can add more buttons to allow for other options. For example, “Save” and “Save and Send”.
-===== Optional Buttons Can be Assigned Shortcut Keys =====
+You can optionally assign a shortcut key by applying a suffix to the Button Name in the form of /«character», which will cause the Button to respond to a keystroke of <key>⌘</key><key>«character»</key> (or just <key>«character»</key> if there are no focusable text fields).
-You can optionally assign a shortcut key by applying a suffix to the Button Name in the form of /«character», which will cause the Button to respond to a keystroke of <key>⌘</key><key>/«character»</key>
 ^Suffix^Button Responds to Shortcut Key of:^
 |`/.`|<key>⎋</key> (ESCAPE) key.|
 |`/`|<kbd>⏎</kbd> (RETURN) key.|
-|`/H`|<key>⌘</key><key>H</key> keystroke (as an example).\\ (The <key>⌘</key> key is not needed IF there are not any text fields in the Prompt User dialog)|
+|`/H`|<key>⌘</key><key>H</key> keystroke (as an example) (or just <key>H</key> if there are not any text fields in the form)|
+|`/-`|no shortcut|
+=== Result Button ===
-===== Result Button =====
+The [[token:PromptButton|%PromptButton%]] token (v8+) is set to the _name_ of the button pressed, and can be used in actions later in this instance like any other text token.  The deprecated _Result Button_ variable is also set to the _name_ of the button pressed.
-The _Result Button_ variable (`%Result Button%`) is set to the _name_ of the button pressed, and can be used in Actions like any other text token.
+=== How Buttons are Processed ===
+* The first button (from the top) has a default key of <kbd>⏎</kbd> (RETURN), _unless_ you have assigned the _RETURN_ response to another button using “/” at the end of a button name, or marked the button to cancel the macro.
-Note that the system will not allow Keyboard Maestro Engine to see keys typed in its own windows so the [[trigger:Typed String | Typed String triggers]] will not work within Keyboard Maestro Engine windows.
+* The second button has a default key of either <key>⎋</key> (ESCAPE), or <key>⌘</key><key>.</key> (COMMAND-PERIOD), _unless_ you have turned off canceling the macro for that button or assigned the _ESCAPE_ response to another button using “/.” at the end of a button name.
-===== How Buttons are Processed =====
-* The first button (from the top) has a default key of <kbd>⏎</kbd> (RETURN).
-* The second button has a default key of either <key>⎋</key> (ESCAPE), or <key>⌘</key><key>.</key> (COMMAND-PERIOD), _unless_ you have assigned the _escape_ response to another button using <key>/</key><key>.</key> at the end of the Button Name.
 * Any button can _Cancel_ the macro if the "Cancel Macro" checkbox is _checked_ for it.
 * Other buttons have no default key.
-* Whatever button has the key <kbd>⏎</kbd> will be the "Default" button, and will be highlighted in blue appropriately by the system.
+* Whatever button has the _RETURN_ response will be the Default button, and will be highlighted in blue appropriately by the system.
-* The button shown with a colored outline (usually blue) can be chosen/activated by pressing the SPACE_BAR key.
+* If you have the system preference “Use keyboard navigation to move focus between controls” enabled, the button shown with a colored outline (usually blue) can be chosen/activated by pressing the _SPACE_ key.
-**Guidelines for Good Button UI**
+=== Guidelines for Good Button User Experience ===
-* The default button should be the "OK" button, the one that performs the *normal behaviour*.
+* The default button should be the “OK” button, the one that performs the *normal behaviour*.
 * The default button should be rightmost.
 * The left most button should be "Cancel".
@@ Line 122: / Line 176: @@
 * If the normal behaviour is significantly dangerous, then it may be appropriate for it to not be the default button, or for there to be no default button.
-"normal behaviour" here is defined as doing what the user just asked to do.
+“Normal behaviour” here is defined as doing what the user just asked to do.
 A consequence of all of this is that if you have a second button in the Prompt For User Input action, and it does not cancel the macro, then you should definitely give it some other key, or disable it with “/-”.
-An update is planned so that if the first button has the Cancel Macro flag, then it is not the default (by default), and if the second button does not have the Cancel Macro flag, then it does not get the Escape/Command-, key (by default).
+===== Notes =====
-Note that the system really really wants a "default" button, and if you do not give it one, it will choose one for you.
+Note that the system will not allow Keyboard Maestro Engine to see keys typed in its own windows so the [[trigger:Typed String]] triggers will not work within Keyboard Maestro Engine windows.
 ===== See Also =====
-----
 === Actions ===
-* [[action:Custom HTML Prompt|Custom HTML Prompt]]
+* [[action:Alert|Alert]] action
-* [[:Actions|See all Actions]]
+* [[action:Prompt_With_List|Prompt With List]] action
+* [[action:Prompt_for_File|Prompt for File]] action
+* [[action:Prompt_for_Screen_Rectangle|Prompt for Screen Rectangle]] action
+* [[action:Custom_HTML_Prompt|Custom HTML Prompt]] action
+* [[action:Show_Palette_of_Macros|Show Palette of Macros]] action
+* [[action:Get_Touch_Bar_Selection|Get Touch Bar Selection]] action
+* [[:Actions|All Actions]]
-----
+=== Tokens ===
-==== Forum ====
+* [[token:AlertButton|%AlertButton%]] token
+* [[token:PromptButton|%PromptButton%]] token
+* [[token:HTMLResult|%HTMLResult%]] token
+* [[:Tokens|All Tokens]]
+=== Forum ===
 - [Using extra buttons to select next action on Prompt for user input](http://forum.keyboardmaestro.com/t/using-extra-buttons-to-select-next-action-on-prompt-for-user-input/1278)
@@ Line 148: / Line 211: @@
 - [Spotlight General Purpose Search](https://forum.keyboardmaestro.com/t/macro-spotlight-general-purpose-search/1790)
 - [[https://forum.keyboardmaestro.com/t/how-to-use-dynamic-choices-in-prompt-for-user-input-action/2755/4|How to Use Dynamic Choices in Prompt for User Input Action?]]
-- [Dynamic Default List for Prompt for User Input (Example)](https://forum.keyboardmaestro.com/t/dynamic-default-list-for-prompt-for-user-input-example/4441)
 - [[https://forum.keyboardmaestro.com/t/dialog-checkbox-state-remembered-between-calls/3168/5|Dialog checkbox state remembered between calls?]]
 - [[https://forum.keyboardmaestro.com/t/using-buttons-in-prompt-for-user-input-for-things-other-than-ok-and-cancel/3861/15|Using buttons in Prompt for User Input for things other than OK and Cancel]]
+- [Dynamic Default List for Prompt for User Input (Example)](https://forum.keyboardmaestro.com/t/dynamic-default-list-for-prompt-for-user-input-example/4441)
+- [[https://forum.keyboardmaestro.com/t/default-selection-in-prompt-for-user-input/5589/4|Default selection in prompt for user input]]
+- [[https://forum.keyboardmaestro.com/search?q=Prompt%20User%20Input|Keyboard Maestro Forum topics about Prompt for User Input]]
-- [[https://www.google.fr/search?q=site:forum.keyboardmaestro.com+Prompt+User+Input|Keyboard Maestro Forum topics about Prompt for User Input]]

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools