Commit 7d334d85 authored by Pablo Rauzy's avatar Pablo Rauzy Committed by Christoph Cullmann
Browse files

update README

parent fa067d37
......@@ -7,35 +7,37 @@ Record and play keyboard macros (i.e., keyboard action sequences).
### To start recording a keyboard macro:
Menu: `Tools > Keyboard Macros > Record Macro…`
Default shortcut: `Ctrl+Shift+K`.
Menu: `Tools > Keyboard Macros > Record Macro...`
The plugin will record every key presses until you end recording.
Default shortcut: `Ctrl+Shift+K`.
### To end recording:
Menu: `Tools > Keyboard Macros > End Macro Recording`
Default shortcut: `Ctrl+Shift+K`.
The plugin will stop recording key presses and save the key presses sequences as the current macro.
Default shortcut: `Ctrl+Shift+K`.
### To cancel recording:
Menu: `Tools > Keyboard Macros > Cancel Macro Recording`
The plugin will stop recording key presses but the current macro won't change.
Default shortcut: `Alt+Shift+K, D`.
Default shortcut: `Ctrl+Alt+Shift+K`.
### To play the current macro:
Menu: `Tools > Keyboard Macros > Play Macro`
The plugin will play the current macro.
Default shortcut: `Ctrl+Alt+K`.
The plugin will play the current macro.
Command: `kmplay` will play the current macro.
## Named macros
......@@ -47,33 +49,41 @@ Named macros are persistent between Kate's sessions, they're saved in the `keybo
Menu: `Tools > Keyboard Macros > Save Current Macro`
Default shortcut: `Alt+Shift+K, S`.
The plugin will prompt you for a name and save the macro under it.
Default shortcut: `Alt+Shift+K`.
Command: `kmsave <name>` will save the current macro under the name `<name>`.
### To load a saved macro as the current one:
Menu: `Tools > Keyboard Macros > Load Named Macro`
Menu: `Tools > Keyboard Macros > Load Named Macro... >`
Default shortcut: `Alt+Shift+K, L`.
The plugin will list saved macros as items in this submenu, activating an item will load the corresponding macro as the current one.
Command: `kmload <name>` will load the macro saved under the name `<name>` as the current one.
### To play a saved macro without loading it:
Menu: `Tools > Keyboard Macros > Play Named Macro... >`
The plugin will list saved macros as items in this submenu, activating an item will play the corresponding macro without loading it.
Command: `kmplay <name>` will play the macro saved under the name `<name>` without loading it.
### To delete a saved macro:
### To wipe (e.g., delete) a saved macro:
Menu: `Tools > Keyboard Macros > Wipe Named Macro... >`
Default shortcut: `Alt+Shift+K, D`.
The plugin will list saved macros as items in this submenu, activating an item will wipe the corresponding macro.
Command: `kmdelete <name>` will delete the macro saved under the name `<name>`.
Command: `kmwipe <name>` will delete the macro saved under the name `<name>`.
### Tips for commands
Note that after the `km` prefix all these commands use a different letter so you can efficiently use them using tab-completion :).
Note that after the `km` prefix all these commands use a different letter so you can efficiently call them using tab-completion :).
## Limitations
As of now, keyboard macros fail to play properly if some types of GUI widgets are used: QMenu, QuickOpenLineEdit, or TabSwitcherTreeView, for example.
I'm not sure why but my first guess would be that it is a combination of these widgets taking time to show up and of the fact that they seem to works differently regarding keyboard events.
I'm not sure why but my first guess would be that these widgets work in a non-standard way regarding keyboard events.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment