xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Mention that commands requiring a client context are unhelpful in a draft context.

Browse Source 
Fixes #2618.
This commit is contained in:
Tim Allen 2018-12-11 14:18:05 +11:00
parent b982371843
commit 18c34408c5
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/pages/commands.asciidoc
View File

@ -284,11 +284,20 @@ but not really useful in that context.
prompt content will be passed as a single token. In other words, prompt content will be passed as a single token. In other words,
word splitting does not take place. word splitting does not take place.
NOTE: The prompt is displayed in and receives input from the
current client context, so inside a draft context like
`evaluate-commands -draft`, it is invisible and only responds to
an `execute-keys` command in the same context.
*on-key* <command>:: *on-key* <command>::
wait for next key from user, then execute <command>, the key is wait for next key from user, then execute <command>, the key is
available through the `key` value, accessible through `$kak_key` available through the `key` value, accessible through `$kak_key`
in shells, or `%val{key}` in commands. in shells, or `%val{key}` in commands.
NOTE: The key press must come from the current client context,
so inside a draft context like `evaluate-commands -draft`, it only
responds to an `execute-keys` command in the same context.
*menu* [<switches>] <label1> <commands1> <label2> <commands2> ...:: *menu* [<switches>] <label1> <commands1> <label2> <commands2> ...::
display a menu using labels, the selected label’s commands are display a menu using labels, the selected label’s commands are
executed. The *menu* command can take an *-auto-single* argument, to automatically executed. The *menu* command can take an *-auto-single* argument, to automatically
@ -297,6 +306,11 @@ but not really useful in that context.
last one being a command to execute when the item is selected (but last one being a command to execute when the item is selected (but
not validated) not validated)
NOTE: The menu is displayed in and receives input from the
current client context, so inside a draft context like
`evaluate-commands -draft`, it is invisible and only responds to
an `execute-keys` command in the same context.
*info* [<switches>] <text>:: *info* [<switches>] <text>::
display text in an information box with the following *switches*: display text in an information box with the following *switches*:
@ -329,6 +343,9 @@ but not really useful in that context.
parse markup in both title (if provided) and text. (See parse markup in both title (if provided) and text. (See
<<faces#markup-strings,`:doc faces markup-strings`>>) <<faces#markup-strings,`:doc faces markup-strings`>>)
NOTE: The info box is displayed in the current client context,
so inside a draft context like `eval -draft`, it is invisible.
*try* <commands> [catch <on_error_commands>]...:: *try* <commands> [catch <on_error_commands>]...::
prevent an error in *commands* from aborting the whole command prevent an error in *commands* from aborting the whole command
execution, execute *on_error_commands* instead. If nothing is to be execution, execute *on_error_commands* instead. If nothing is to be