diff --git a/README.md b/README.md index 8072471..7294618 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,72 @@ # Multi_Clipboard for AHKv2 -![Example of Multi_Clipboard GUI](https://i.imgur.com/fw1q83V.png) +![Image:Example of Multi_Clipboard GUI](https://i.imgur.com/fw1q83V.png) ## What is it? A script to provide multi-clipboard support. -![Number set image](https://i.imgur.com/mJlvE3T.png) +![Image:Keyboard Number Sets](https://i.imgur.com/mJlvE3T.png) It turns any/some/all of the number sets on the keyboard into extra clipboard slots. You have 32 extra clipboard slots if all number sets are used. -You control them by setting/using different modifiers as ![action keys](https://i.imgur.com/6GyGpML.png). +The keys are controlled by modifier keys that you set. +![Image:Modifier keys](https://i.imgur.com/6GyGpML.png) + Example. If numpad clipboards are enabled, `copy_mod` is `^` ctrl, and `paste_mod` is `!` alt: ctrl+numpad5 will copy to slot Numpad5 and alt+numpad5 pastes whatever is stored in Numpad5. ## Properties ### Number Set Properties -* `use_pad` -Enables number pad keys to be used as clipboards. +* `use_pad := 1` [bool] + Enables number pad keys to be used as clipboards. -* `use_bar` -Enables the number bar row to be used as clipboards. +* `use_bar := 1` [bool] + Enables the number bar row to be used as clipboards. -* `use_f` -Enables the Function number keys to be used as clipboards. - -___ Modifier actions _____________________________________________________________________________ -copy_mod [str] = Modifier that copies to a key -paste_mod [str] = Modifier that pastes from a key -show_mod [str] = Modifier shows contents of a key. Valid modifiers: - = ! Alt ^ Ctrl + Shift # Windows < LeftSideMod > RightSideMod +* `use_f := 1` [bool] + Enables the Function number keys to be used as clipboards. -___ Hotkey _______________________________________________________________________________________ -all_hotkey [str] = A Hotkey to show contents of all clipboards +### Modifier Actions +Modifier actions should be assigned a hotkey modifier symbol/symbols. +Modifier keys are expected to be the same as AHK's [`Hotkey Modifier Symbols`](https://www.autohotkey.com/docs/v2/Hotkeys.htm#Symbols) +Symbols Indluce: `!` Alt, `^` Control, `#` Win, `+` Shift, `<` Left Side Modifier `>` Right Side Modifier + +`copy_mod` [string] +Modifier that copies to a clipboard key + +`paste_mod` [string] +Modifier that pastes from a clipboard key + +`show_mod` [string] +Modifier that shows contents of a clipboard key. + +### Hotkey +`all_hotkey` [str] +This is the only full hotkey you define and can be any modifer+hotkey combo you want. +Examples: `all_hotkey := '^NumpadEnter` or ```all_hotkey := '!``' ``` (Alt+Backtick) -___ Optional Properties __________________________________________________________________________ -enable [bool] = true -> Enables all hotkeys (does not override disable_list) +### Optional Properties +`enable` [bool] +true -> Enables all hotkeys (does not override disable_list) = false -> Disables all hotkeys -send_hotkey [bool] = true -> Native keystroke is included with the action remap +`send_hotkey` [bool] = true -> Native keystroke is included with the action remap = false -> Native keystroke is replaced by the action remap -quick_view [bool] = true -> key down shows pop GUI and closes on key release +`quick_view` [bool] = true -> key down shows pop GUI and closes on key release = false -> Key press pops up GUI and it stays up until closed -hide_empty [bool] = true -> Empty clipboards are omitted from display when shown +`hide_empty` [bool] = true -> Empty clipboards are omitted from display when shown = false -> Empty clipboards show with key headers and as -hide_binary [bool] = true -> Binary data clipboards are omitted from display when shown +`hide_binary` [bool] = true -> Binary data clipboards are omitted from display when shown = false -> Binary data clipboards show with key headers and as -show_max_char [num] = Max number of characters to show from each clipboard string +`show_max_char` [num] = Max number of characters to show from each clipboard string = 0 disables max and uses the full string -disable_list [arr] = An array of strings containing WinTitles +`disable_list` [arr] = An array of strings containing WinTitles = Multi_Clipboard will be disabled in any of the provided WinTitles = WinTitle Docs: https://www.autohotkey.com/docs/v2/misc/WinTitle.htm -___ METHODS ______________________________________________________________________________________ -toggle() = Toggles the enable property on/off - Return = The new enable state after toggle -__________________________________________________________________________________________________ -Example: Enabling numpad, using ctrl for copy, alt for paste, and win for show: - All Numpad number keys act as individual clipboard slots - Pressing Ctrl+Numpad# will copy whatever has focus to a slot with that hotkey as a key - Pressing Alt+Numpad# will paste the contents - ANd Win+Numpad# will show the contents of that save in a GUI popup +### METHODS +`toggle()` + Toggles the enable property on/off + `Return` New enable state after the toggle + __________________________________________________________________________________________________ ## Why make it if it's a common script to make? It initially started out as a response to a post on the AHK subreddit.