Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 61 lines (49 sloc) 2.509 kB
6ef3111 @agibsonsw Initial commit
authored
1 AndyEdits
2 =========
3
406f267 @agibsonsw Update README.md
authored
4 Jump between edited regions - optional gutter icon
a14337e @agibsonsw Update README.md
authored
5 THERE IS CURRENTLY A RENDERING ISSUE WITH WINDOWS
cae2d21 @agibsonsw First full commit
authored
6
e7b9ed4 @agibsonsw Update README.md
authored
7 Can jump to next or previous edited-region or use a
cae2d21 @agibsonsw First full commit
authored
8 quick-panel which shows the edited text and line number.
b40062f @agibsonsw Update README.md
authored
9 (If the edited text is just whitespace then the panel
cae2d21 @agibsonsw First full commit
authored
10 will display the full line's text.)
11
e7b9ed4 @agibsonsw Update README.md
authored
12 A shortcut can toggle outlining of the edited regions.
b42c975 @agibsonsw Update README.md
authored
13 An optional icon can appear in the gutter. You
8a281da @agibsonsw Update README.md
authored
14 could use your own icon if you prefer! icon_scope
15 determines the colour of the icon and outlining:
77d6f90 @agibsonsw Update README.md
authored
16 "class" works well for me. icon_current is the scope
b42c975 @agibsonsw Update README.md
authored
17 for the current edit-region.
cae2d21 @agibsonsw First full commit
authored
18
dce2ffa @agibsonsw Update README.md
authored
19 You can remove the edit history for a region using
2627083 @agibsonsw Update README.md
authored
20 another shortcut, via a quick panel (although you
4745e05 @agibsonsw Update README.md
authored
21 cannot remove the most recent edit). If you highlight
22 some text you can create/add it as an edit-region.
dce2ffa @agibsonsw Update README.md
authored
23
a74ce88 @agibsonsw Update README.md
authored
24 You can list, and jump to, edits across all open files.
25
e7b9ed4 @agibsonsw Update README.md
authored
26 Details for edited regions will persist if you close ST,
cae2d21 @agibsonsw First full commit
authored
27 but not if you close the file/view. This is the
28 default persistence behaviour for ST.
29
30 My suggestions for your Key Bindings (User) are:
dce2ffa @agibsonsw Update README.md
authored
31 { "keys": ["ctrl+alt+d"], "command": "delete_edit" },
cae2d21 @agibsonsw First full commit
authored
32 { "keys": ["ctrl+alt+h"], "command": "toggle_edits" },
33 { "keys": ["ctrl+alt+j"], "command": "quick_edits" },
34 { "keys": ["ctrl+alt+k"], "command": "prev_edit_line" },
a74ce88 @agibsonsw Update README.md
authored
35 { "keys": ["ctrl+alt+l"], "command": "next_edit_line" },
4745e05 @agibsonsw Update README.md
authored
36 { "keys": ["ctrl+alt+m"], "command": "list_all_edits" },
37 { "keys": ["ctrl+alt+c"], "command": "create_edit" }
6bbbe0b @agibsonsw Update README.md
authored
38
a74ce88 @agibsonsw Update README.md
authored
39 CURRENT LIMITATIONS:
e7b9ed4 @agibsonsw Update README.md
authored
40 Mulitple Undo, Redo can disturb the edit-history: use Create and/or
515a0f8 @agibsonsw Update README.md
authored
41 Delete edit-region to correct this. This is a consequence of the
e7b9ed4 @agibsonsw Update README.md
authored
42 ST-API behaviour.
fea9277 @agibsonsw Update README.md
authored
43
4f7bb00 @agibsonsw Update README.md
authored
44 Multi-select will only remember the first selection area.
45
e7b9ed4 @agibsonsw Update README.md
authored
46 It doesn't include automatically inserted (matched) brackets
47 or quotes within the current edit-region, unless editing starts on
48 a new line or at the end of an existing line. Therefore, the
49 edit-region may be split into several edits, and/or the region may
50 end before it should. Selecting the area and using Ctrl-Alt-C to
51 Create a new (single) edit-region will correct this. This can be
52 done at any time and allows you to explicity determine the start
53 and end points for the edit-region.
e0374a5 @agibsonsw Update README.md
authored
54
55 ST-API ISSUE:
4776056 @agibsonsw Update README.md
authored
56 An issue when using add_regions() with Windows, and relating to colour
57 themes, may arise. The gutter icon may not display and the scrollbar
58 and ruler may be poorly rendered. Switching to a default theme and back
e0374a5 @agibsonsw Update README.md
authored
59 to your chosen theme should resolve this. You may also need to close
60 and re-start ST.
Something went wrong with that request. Please try again.