Skip to content

Commit b3758dc

Browse files
LokaltogLokaltog
committed
Merge branch 'release/1.0.11'
* release/1.0.11: Bump version Update docs Update readme
2 parents 5809794 + 140f53a commit b3758dc

File tree

2 files changed

+84
-44
lines changed

2 files changed

+84
-44
lines changed

‎README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Summary
1+
# Introduction
22

33
EasyMotion provides a much simpler way to use some motions in vim. It
44
takes the `<number>` out of `<number>w` or `<number>f{char}` by
@@ -9,23 +9,32 @@ When one of the available motions is triggered, all visible text
99
preceding or following the cursor is faded, and motion targets are
1010
highlighted.
1111

12-
EasyMotion is triggered manually or by one of the provided mappings.
12+
EasyMotion is triggered by one of the provided mappings.
1313

14-
Example:
14+
## Usage example
1515

16-
<cursor>Lorem ipsum dolor sit amet.
17-
18-
If the word motion `w` is triggered with the default mapping
19-
`<Leader>w`, the text is updated (no braces are actually added, the
20-
letters are highlighted in red by default):
16+
Type `<Leader>w` to trigger the word motion `w`. When the motion is
17+
triggered, the text is updated (no braces are actually added, the text
18+
is highlighted in red by default):
2119

2220
<cursor>Lorem {a}psum {b}olor {c}it {d}met.
2321

2422
Press `c` to jump to the beginning of the word "sit":
2523

2624
Lorem ipsum dolor <cursor>sit amet.
2725

28-
And that's it!
26+
Similarly, if you're looking for an "o", you can use the `f` motion.
27+
Type `<Leader>fo`, and all "o" characters are highlighted:
28+
29+
<cursor>L{a}rem ipsum d{b}l{c}r sit amet.
30+
31+
Press `b` to jump to the second "o":
32+
33+
Lorem ipsum d<cursor>olor sit amet.
34+
35+
Jeffrey Way of Nettuts+ has also [written
36+
a tutorial](http://net.tutsplus.com/tutorials/other/vim-essential-plugin-easymotion/)
37+
about EasyMotion.
2938

3039
## Animated demonstration
3140

‎doc/easymotion.txt

Lines changed: 66 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*easymotion.txt* Version 1.0.10. Last change: 2011 Mar 30
1+
*easymotion.txt* Version 1.0.11. Last change: 2011 Mar 31
22

33

44
______ __ ___ __ _
@@ -15,6 +15,7 @@ CONTENTS *easymotion-contents*
1515

1616
1. Introduction ....................... |easymotion-introduction|
1717
2. Usage .............................. |easymotion-usage|
18+
2.1 Default mappings ............... |easymotion-default-mappings|
1819
3. Requirements ....................... |easymotion-requirements|
1920
4. Configuration ...................... |easymotion-configuration|
2021
4.1 EasyMotion_keys ................ |EasyMotion_keys|
@@ -40,25 +41,55 @@ following the cursor is faded, and motion targets are highlighted.
4041
==============================================================================
4142
2. Usage *easymotion-usage*
4243

43-
EasyMotion is triggered manually or by one of the provided mappings (see
44+
EasyMotion is triggered by one of the provided mappings (see
4445
|EasyMotion_do_mapping| for details).
4546

4647
Example: >
4748
48-
<cursor>Lorem ipsum dolor sit amet.
49+
<cursor>Lorem ipsum dolor sit amet.
4950
50-
If the word motion |w| is triggered with the default mapping <Leader>w, the
51-
text is updated like this (no braces are actually added, the letters are
52-
highlighted in red by default): >
51+
Type <Leader>w to trigger the word motion |w|. See |mapleader| for details
52+
about the leader key. When the motion is triggered, the text is updated (no
53+
braces are actually added, the text is highlighted in red by default): >
5354
54-
<cursor>Lorem {a}psum {b}olor {c}it {d}met.
55+
<cursor>Lorem {a}psum {b}olor {c}it {d}met.
5556
5657
Press "c" to jump to the beginning of the word "sit": >
5758
58-
Lorem ipsum dolor <cursor>sit amet.
59+
Lorem ipsum dolor <cursor>sit amet.
60+
61+
Similarly, if you're looking for an "o", you can use the |f| motion.
62+
Type <Leader>fo, and all "o" characters are highlighted: >
63+
64+
<cursor>L{a}rem ipsum d{b}l{c}r sit amet.
65+
66+
Press "b" to jump to the second "o": >
67+
68+
Lorem ipsum d<cursor>olor sit amet.
5969
6070
And that's it!
6171

72+
------------------------------------------------------------------------------
73+
2.1 Default mappings *easymotion-default-mappings*
74+
75+
The default configuration provides the following mappings in both normal and
76+
visual mode:
77+
78+
Mapping | Details
79+
------------------|----------------------------------------------
80+
<Leader>f{char} | Find {char} to the right. See |f|.
81+
<Leader>F{char} | Find {char} to the left. See |F|.
82+
<Leader>t{char} | Till before the {char} to the right. See |t|.
83+
<Leader>T{char} | Till after the {char} to the left. See |T|.
84+
<Leader>w | Beginning of word forward. See |w|.
85+
<Leader>b | Beginning of word backward. See |b|.
86+
<Leader>e | End of word forward. See |e|.
87+
<Leader>ge | End of word backward. See |ge| .
88+
<Leader>j | Line downward. See |j|.
89+
<Leader>k | Line upward. See |k|.
90+
91+
See |mapleader| for details about the leader key.
92+
6293
==============================================================================
6394
3. Requirements *easymotion-requirements*
6495

@@ -70,68 +101,68 @@ Vi-compatible mode must be disabled.
70101
==============================================================================
71102
4. Configuration *easymotion-configuration*
72103

73-
Set the configuration variables globally in your vimrc file.
104+
EasyMotion will work fine without any configuration, but you can override the
105+
default behavior by setting configuration variables globally in your |vimrc|
106+
file.
74107

75-
Example: >
108+
Example (this will change the target keys and disable shading): >
76109
77-
let g:EasyMotion_keys = '1234567890'
78-
let g:EasyMotion_do_shade = 0
110+
let g:EasyMotion_keys = '1234567890'
111+
let g:EasyMotion_do_shade = 0
79112
80113
------------------------------------------------------------------------------
81114
4.1 EasyMotion_keys *EasyMotion_keys*
82115

83116
Set the keys which will be used for motion targets. Add as many keys as you
84-
want. There's a lower chance that the motion targets will be grouped with many
85-
keys available.
117+
want. There's a lower chance that the motion targets will be grouped if many
118+
keys are available.
86119

87120
Default: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
88121

89122
------------------------------------------------------------------------------
90123
4.2 EasyMotion_target_hl *EasyMotion_target_hl*
91124

92-
Set the highlighting group for motion targets.
125+
Set the highlighting group for motion targets. You can override the default
126+
target highlighting by either changing this variable to another highlighting
127+
group (e.g. |ErrorMsg|), or by using |hi| to override the default syntax
128+
colors: >
129+
130+
hi EasyMotionTarget ctermfg=green ctermbg=black cterm=reverse
93131
94132
Default: 'EasyMotionTarget'
95133

96134
------------------------------------------------------------------------------
97135
4.3 EasyMotion_shade_hl *EasyMotion_shade_hl*
98136

99-
Set the highlighting group for shaded text.
137+
Set the highlighting group for shaded text (see |EasyMotion_do_shade|). You
138+
can override the default shade highlighting by either changing this variable
139+
to another highlighting group, or by using |hi| to override the default syntax
140+
colors: >
141+
142+
hi EasyMotionShade ctermfg=red ctermbg=black cterm=none
100143
101144
Default: 'EasyMotionShade'
102145

103146
------------------------------------------------------------------------------
104147
4.4 EasyMotion_do_shade *EasyMotion_do_shade*
105148

106-
Set this to 0 if you want to disable text shading.
149+
The default behavior is to shade the text following the cursor (forward
150+
motions) or preceding the cursor (backward motions) to make the motion targets
151+
more visible. Set this option to 0 if you want to disable text shading.
107152

108153
Default: 1
109154

110155
------------------------------------------------------------------------------
111156
4.5 EasyMotion_do_mapping *EasyMotion_do_mapping*
112157

113-
Set this to 0 if you want to disable the default mappings. The default
114-
configuration provides the following mappings in both normal and visual
115-
mode:
116-
117-
Mapping Details
118-
--------------------------
119-
<Leader>f{char} See |f|
120-
<Leader>F{char} See |F|
121-
<Leader>t{char} See |t|
122-
<Leader>T{char} See |T|
123-
<Leader>w See |w|
124-
<Leader>e See |e|
125-
<Leader>b See |b|
126-
<Leader>ge See |ge|
127-
<Leader>j See |j|
128-
<Leader>k See |k|
129-
130-
Default: 1
158+
Set this option to 0 if you want to disable the default mappings. See
159+
|easymotion-default-mappings| for details about the default mappings.
131160

132161
Note: If you disable this option, you'll have to map the motions yourself. See
133162
the plugin source code for mapping details.
134163

164+
Default: 1
165+
135166
==============================================================================
136167
5. License *easymotion-license*
137168

0 commit comments

Comments
 (0)