summaryrefslogtreecommitdiffstats
path: root/docs/Custom_Command_Keybindings.md
diff options
context:
space:
mode:
authorElwardi <elwardifadeli@gmail.com>2021-08-06 18:38:26 +0100
committerElwardi <elwardifadeli@gmail.com>2021-08-06 18:38:26 +0100
commitdcd3b7c058f9c1289234c2ec174d6dd9802e96e2 (patch)
tree0e1d87e194e819155ee60251fa64283350c7cc84 /docs/Custom_Command_Keybindings.md
parent906ec30cac9ea632006b295b30bca732498f81bc (diff)
Show only labels in menuFromCommand prompts
Diffstat (limited to 'docs/Custom_Command_Keybindings.md')
-rw-r--r--docs/Custom_Command_Keybindings.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/Custom_Command_Keybindings.md b/docs/Custom_Command_Keybindings.md
index 9a5c89609..c48442362 100644
--- a/docs/Custom_Command_Keybindings.md
+++ b/docs/Custom_Command_Keybindings.md
@@ -103,14 +103,16 @@ The permitted prompt fields are:
| | menu options | |
| filter | (only applicable to 'menuFromCommand' prompts) the regexp to run specifying | yes |
| | groups which are going to be kept from the command's output | |
-| valueFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes |
-| | the filter to construct a menu item. You can use named groups, | yes |
+| valueFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes |
+| | the filter to construct a menu item's value (What gets appended to prompt | |
+| | responses when the item is selected). You can use named groups, | |
| | or `{{ .group_GROUPID }}`. | |
-| | PS: named groups keep first match only | yes |
-| labelFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes |
-| | the filter to construct a menu item's description. You can use named groups, | yes |
-| | or `{{ .group_GROUPID }}`. | |
-| | PS: named groups keep first match only | yes |
+| | PS: named groups keep first match only | |
+| labelFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | no |
+| | the filter to construct the item's label (What's shown on screen). You can use | |
+| | named groups, or `{{ .group_GROUPID }}`. If this is not specified, `valueFormat` | |
+| | is shown instead. | |
+| | PS: named groups keep first match only | |
The permitted option fields are:
| _field_ | _description_ | _required_ |