OSDN Git Service

Updated changelog & removed junk file.
[neighbornote/NeighborNote.git] / shortcuts_howto.txt
1 I've tried to add the ability to customize your NixNote menu shortcuts,
2 but I don't want to take the time to setup a new dialog box and all the
3 junk that entails.  So, I chose a text file config instead.  Eventually I 
4 may change it so the text file can be edited within the running program, but
5 I have other things to spend my time on at the moment.
6
7 First, you don't need to do this.  Nixnote comes with a default set of 
8 shortcuts.  If you are happy with those then you don't need to do a thing.
9
10 If you want to customize your shortcuts then you need to do a little work.
11
12 You should have a shortcuts_sample.txt file.  Copy this to shortcuts.txt 
13 in your Nixnote home directory (~/.nevernote on Linux & OS-X and your user
14 home directory on Windows).  This is the file that is read 
15 when Nixnote starts.  Any changes to this file only happen at startup
16 so if you change it you need to restart the program to see those changes.
17
18 This file has three main columns.  
19
20 The first column is the menu item you are wanting to trigger with the
21 shortcut.  For example, File_Note_Add is the shortcut to add a note and
22 Tools_Connect is the shortcut under the tools menu to connect.
23
24 The second column is the shortcut sequence.  For example, "Ctrl+N" or
25 "F10" or "Ctrl+Shift+F12".  
26
27 The remainder of the line is comments and comments should begin
28 with // characters.  Spaces or tabs are treated as delimiters.
29
30 When editing the file, you must have at least the first column (i.e.
31 File_Note_Add).  If you do not put anything else on that line or 
32 if you just have comments on the rest of the line you will be 
33 removing that shortcut.  For example, a line like this will cause 
34 the shortcut to add a note to be removed.
35
36 File_Note_Add              // Remove that shortcut
37
38 If you want to change a shortcut, then put the shortcut sequece.  For example, 
39 this line would change the note add shortcut to Ctrl+W
40
41 File_Note_Add    Ctrl+W    // Odd shortcut
42
43 If you choose a shortcut key sequence that already exists in the it will 
44 remove that default shortcut and assign it to your custom shortcut.  If
45 you put the same shortcut twice or the same action twice with two
46 different shortcuts, the last one will be the one used.
47
48 In you shortcuts.txt you only need to put the shortcuts you want
49 changed.  Any action not in that file will use the default shortcut (or
50 will use the default of no shortcut).  It doesn't hurt to use the 
51 complete sample shortcut file, but I'd recommend only having the shortcuts
52 you want changed in shortcuts.txt.  It will probably make it easier in the
53 long run for you to support if I add other shortcuts later.
54
55 Good luck.