rolandwalker / button-lock

clickable text in Emacs
42 stars 6 forks source link

Change the default ‘C-c w’ and ‘C-c W’ key-bindings #2

Closed ejmr closed 10 years ago

ejmr commented 10 years ago

Section 22.2.1 of the Emacs Lisp Manual, “Major Mode Conventions,” says the following about keys:

The key sequences bound in a major mode keymap should usually
start with ‘C-c’, followed by a control character, a digit, or
‘{’, ‘}’, ‘<’, ‘>’, ‘:’ or ‘;’.  The other punctuation characters
are reserved for minor modes, and ordinary letters are reserved
for users.

Users should be able to safely use a key sequence such as ‘C-c w’ without concern for conflicts with any major mode. However, Wiki Nav Mode violates that reservation. Therefore, this patch changes

C-c w    ->    C-c C-w
C-c W    ->    C-c C-W

in order to avoid conflicts with users’ keys.

ejmr commented 10 years ago

I made a mistake in the commit message: the correct section is 23.2.1. I recently started using Wiki Nav Mode, which I'm finding very useful. But today I discovered it conflicts with a personal key-binding (C-c w) which I use for writing email, hence this patch.

rolandwalker commented 10 years ago

Sure, thanks!

I'm guilty of not using any of the published bindings for these libraries. (My own are even more contrary to the manual.) So whatever minimizes conflicts and helps a user get started.

I'm glad you find the library useful. There's much that could be done to make it better, but it seems like I stopped at Good Enough.

ejmr commented 10 years ago

I'm glad you find the library useful. There's much that could be done to make it better, but it seems like I stopped at Good Enough.

It is certainly "Good Enough" already, in my opinion. Thanks for the mode and for the quick merge.