Skip to content

Commit 62cb12e

Browse files
committed
Shortcut Mapper improvements
Better describe the Shortcut Mapper: - Filter does Name and Shortcut for most, just Name for Scintilla (cf: https://community.notepad-plus-plus.org/post/90244) - Clarify what "Scintilla" is (since most Notepad++ users have no clue why that tab is called "Scintilla") - Improve formatting
1 parent 46c2041 commit 62cb12e

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

content/docs/preferences.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -603,33 +603,33 @@ If you change a color in your Style Configurator, but the color doesn't change i
603603

604604
The Shortcut Mapper dialog presents five tabs:
605605

606-
1. `Main menu`: used for items in the main Notepad++ menu items, like File, Edit, Search, View, Encoding, Language, Settings, Run, and ? (Help/About) menus.
607-
2. `Macros`: used for items in the Macros menu
608-
3. `Run commands`: used for user-added items in the Run menu. (The **Run...** menu entry shortcut is defined in the `Main Menu` tab)
609-
4. `Plugin commands`: used for actions from the Plugins menu.
610-
5. `Scintilla commands`: used for all the Scintilla actions, thus allowing editing of shortcuts for all the editor commands.
606+
1. `Main menu`: Used for items in the main Notepad++ menu items, like File, Edit, Search, View, Encoding, Language, Settings, Run, and ? (Help/About) menus.
607+
2. `Macros`: Used for items in the Macros menu
608+
3. `Run commands`: Used for user-added items in the Run menu. (The **Run...** menu entry shortcut is defined in the `Main Menu` tab)
609+
4. `Plugin commands`: Used for actions from the Plugins menu.
610+
5. `Scintilla commands`: Used for editing shortcuts for the various editor commands -- the things that happen inside the main text-editing portion of Notepad++ (navigating through the text, selecting text, copy/cut/paste, and other such editing actions; these use the "Scintilla" library internally, hence the name of this tab).
611611

612-
Each tab consists of an area for selecting the command to shortcut, a message area, a Filter input, and buttons to Modify, Clear, Delete, and Close.
612+
Each tab consists of an area for selecting the command to shortcut, a message area, a **Filter** input, and buttons to **Modify**, **Clear**, **Delete**, and **Close**.
613613

614614
When selecting the command, there are generally two columns: Name and Shortcut. The Name matches the menu item (or the name of the Scintilla message). The Shortcut shows the current-assigned shortcut (if any). The `Main menu` tab has an additional Category column, which tells which menu category the command falls under. The `Plugin commands` tab has an additional Plugin column, which tells which plugin DLL the shortcut applies to.
615615

616616
The message area will tell you if there are "no shortcut conflicts for this item" (when the shortcut for the selected action is not used anywhere else; or it will give you the name of the tab, followed by the Name for the action, which uses the same shortcut as the currently-selected action.
617617

618-
The Filter input allows you to enter a piece of literal text, and it will filter all the Names in the active tab for a given text substring, only listing the Names that contain that literal substring, ignoring case. There are no regular expression or wildcard syntax interpretations in the Filter.
618+
The **Filter** input box allows you to enter a piece of literal text, and it will filter all the Names in the active tab for a given text substring, only listing the Names that contain that literal substring, ignoring case. (For all but the `Scintilla commands` tab, this also filters based on Shortcut.) There are no regular expression or wildcard syntax interpretations in the Filter.
619619

620-
Use the Modify button to edit the existing shortcut or to create a shortcut for an entry that has none. The resulting dialog will show the Name of the active action. There are checkboxes to enable the CTRL, ALT, and SHIFT key-modifiers. The main key in the shortcut is defined by the pulldown menu. Hitting OK will apply the added or changed shortcut and leave the dialog. Cancel will undo your changes and leave the dialog. (Please note that if you are using some localizations, the key you select [might not match](https://notepad-plus-plus.org/community/topic/17679/using-caret-circumflex-key-for-a-shortcut/10) <!-- TODO = this link should really refer to a submitted issue request, rather than a forum-topic --> what key you type: whatever key in your locale uses the same keycode as the standard US English keyboard will be the actual key.)
620+
Use the **Modify** button to edit the existing shortcut or to create a shortcut for an entry that has none. The resulting dialog will show the Name of the active action. There are checkboxes to enable the CTRL, ALT, and SHIFT key-modifiers. The main key in the shortcut is defined by the pulldown menu. Hitting **OK** will apply the added or changed shortcut and leave the dialog. **Cancel** will undo your changes and leave the dialog. (Please note that if you are using some localizations, the key you select [might not match](https://notepad-plus-plus.org/community/topic/17679/using-caret-circumflex-key-for-a-shortcut/10) <!-- TODO = this link should really refer to a submitted issue request, rather than a forum-topic --> what key you type: whatever key in your locale uses the same keycode as the standard US English keyboard will be the actual key.)
621621

622-
In the `Scintilla commands` tab, you can actually assign more than one shortcut to a given Scintilla command, so there is an extra pane listing existing shortcuts, and additional Add and Remove buttons. For more on the meaning of the `SCI_xxxx` names in the `Scintilla commands` tab, see the section on [Other Editing Commands and Shortcuts](../editing/#other-editing-commands-and-shortcuts).
622+
In the `Scintilla commands` tab, you can actually assign more than one shortcut to a given Scintilla command, so there is an extra pane listing existing shortcuts, and additional **Add** and **Remove** buttons. For more on the meaning of the `SCI_xxxx` names in the `Scintilla commands` tab, see the section on [Other Editing Commands and Shortcuts](../editing/#other-editing-commands-and-shortcuts).
623623

624-
For entries on all the tabs except the `Scintilla commands` tab, the Clear button can be used to remove the existing shortcut for the selected entry. Alternatively, you can click the Modify button in the Shortcut mapper main window and then select None from the pulldown in the Shortcut window that appears, and choose OK to finish.
624+
For entries on all the tabs except the `Scintilla commands` tab, the **Clear** button can be used to remove the existing shortcut for the selected entry. Alternatively, you can click the **Modify** button in the **Shortcut mapper** main window and then select **None** from the pulldown in the **Shortcut** window that appears, and choose **OK** to finish.
625625

626-
For entries on the `Scintilla commands` tab, the Clear button is disabled and will not work; instead, select Modify to get into the mode that allows you to edit `Scintilla commands` shortcuts: if there are multiple shortcuts listed in the left pane, click on the shortcut you wish to remove, and click the Remove button; if there is only one shortcut remaining in the left pane, click on it, choose `None` from the key-combo pulldown menu on the right, then click Apply. Either way, when done deleting shortcuts from this command, hit OK to finish.
626+
For entries on the `Scintilla commands` tab, the **Clear** button is disabled and will not work; instead, select **Modify** to get into the mode that allows you to edit `Scintilla commands` shortcuts: if there are multiple shortcuts listed in the left pane, click on the shortcut you wish to remove, and click the **Remove** button; if there is only one shortcut remaining in the left pane, click on it, choose `None` from the key-combo pulldown menu on the right, then click **Apply**. Either way, when done deleting shortcuts from this command, hit **OK** to finish.
627627

628-
The Delete button is usually disabled (greyed out). However, in the `Macros` and `Run commands` menu, the Delete button will be enabled (not greyed out), and clicking it will remove the selected entry from the menu -- so it will not only not have a shortcut, but it won't be in the menu the next time you run Notepad++.
628+
The **Delete** button is usually disabled (greyed out). However, in the `Macros` and `Run commands` menu, the **Delete** button will be enabled (not greyed out), and clicking it will remove the selected entry from the menu -- so it will not only not have a shortcut, but it won't be in the menu the next time you run Notepad++.
629629

630-
The Close button will close the dialog box.
630+
The **Close** button will close the dialog box.
631631

632-
_Please Note_: Notepad++ honors standard Windows behavior with keystrokes for menu accelerators: typing `Alt` with the first letter (or underlined letter) for a main menu entry will open that menu. If you want to define `Alt+`_Letter_ for some other action, you may do so using the Shortcut Mapper, and that accelerator will no longer work for the menu, but will instead access the action you mapped it to; undefining that new Mapper entry will allow Windows to treat that sequence as the accelerator again. Shortcut Mapper cannot change or clear the Windows accelerator for a menu entry -- it can just preempt that accelerator key to use for something else. (Because the `X` on the right of the menu bar, which closes the active tab, was created as a menu action on the main menu bar with the name "X" through version 8.4.2, its accelerator was therefore `Alt+X`; in v8.4.3, the name was changed to the symbol "✕" instead, so `Alt+X` will no longer activate that action; if you would like to make `Alt+X` work on v8.4.3-and-newer, you can go to the `Main menu` tab in the Shortcut Mapper and change the Shortcut for Close to `Alt+X` instead of the default `Ctrl+W`.)
632+
_Please Note_: Notepad++ honors standard Windows behavior with keystrokes for menu accelerators: typing `Alt` with the first letter (or underlined letter) for a main menu entry will open that menu. If you want to define `Alt+`_Letter_ for some other action, you may do so using the **Shortcut Mapper**, and that accelerator will no longer work for the menu, but will instead access the action you mapped it to; undefining that new Mapper entry will allow Windows to treat that sequence as the accelerator again. **Shortcut Mapper** cannot change or clear the Windows accelerator for a menu entry -- it can just preempt that accelerator key to use for something else. (Because the `X` on the right of the menu bar, which closes the active tab, was created as a menu action on the main menu bar with the name "X" through version 8.4.2, its accelerator was therefore `Alt+X`; in v8.4.3, the name was changed to the symbol "✕" instead, so `Alt+X` will no longer activate that action; if you would like to make `Alt+X` work on v8.4.3-and-newer, you can go to the `Main menu` tab in the **Shortcut Mapper** and change the Shortcut for Close to `Alt+X` instead of the default `Ctrl+W`.)
633633

634634
### Configuration file: `shortcuts.xml`
635635

0 commit comments

Comments
 (0)