diff options
Diffstat (limited to 'doc/camelcasemotion.txt')
| -rw-r--r-- | doc/camelcasemotion.txt | 46 |
1 files changed, 24 insertions, 22 deletions
diff --git a/doc/camelcasemotion.txt b/doc/camelcasemotion.txt index 87997fa..8e48b3d 100644 --- a/doc/camelcasemotion.txt +++ b/doc/camelcasemotion.txt @@ -1,4 +1,4 @@ -*camelcasemotion.txt* Motion through CamelCaseWords and underscore_notation. +*camelcasemotion.txt* Motion through CamelCaseWords and underscore_notation. CAMEL CASE MOTION by Ingo Karkat *camelcasemotion.vim* @@ -18,7 +18,7 @@ the current word. Most programming languages use either CamelCase ("anIdentifier") or underscore_notation ("an_identifier") naming conventions for identifiers. The best way to navigate inside those identifiers using Vim built-in motions is the [count]f{char} motion, i.e. f{uppercase-char} or f_, -respectively. But we can make this easier: +respectively. But we can make this easier: This script defines motions |<leader>w|, |<leader>b| and |<leader>e| (similar to |w|, |b|, |e|), which do not move word-wise (forward/backward), but @@ -28,13 +28,13 @@ characters. From here on, both CamelCase and underscore_notation entities are referred to as "words" (in double quotes). Just like with the regular motions, a [count] can be prepended to move over multiple "words" at once. Outside of "words" (e.g. in non-keyword characters like // or ;), the new motions move -just like the regular motions. +just like the regular motions. Vim provides a built-in |iw| text object called 'inner word', which works in operator-pending and visual mode. Analoguous to that, this script defines inner "word" motions |i<leader>w|, |i<leader>b| and |i<leader>e|, which select the "word" (or multiple "words" if a [count] is given) where the cursor is -located. +located. ============================================================================== USAGE *camelcasemotion-usage* @@ -44,7 +44,7 @@ USAGE *camelcasemotion-usage* Use the new motions |<leader>w|, |<leader>b| and |<leader>e| in normal mode, operator-pending mode (cf. |operator|), and visual mode. For example, if the cursor is on the 'm', type 'bc<leader>w' to change 'Camel' in 'CamelCase' to -something else. +something else. EXAMPLE: motions @@ -70,7 +70,7 @@ v3i<leader>w selects script_31337_path_and_[name_without_extension_]11 v3i<leader>b selects script_31337_[path_and_name]_without_extension_11 v3i<leader>e selects script_31337_path_and_[name_without_extension]_11 Instead of visual mode, you can also use c3i<leader>w to change, d3i<leader>w -to delete, gU3i<leader>w to upper-case, and so on. +to delete, gU3i<leader>w to upper-case, and so on. ============================================================================== INSTALLATION *camelcasemotion-installation* @@ -81,27 +81,29 @@ the archive first, e.g. using WinZip. Inside Vim, install by sourcing the vimball or via the |:UseVimball| command. > vim camelcasemotion.vba.gz :so % -To uninstall, use the |:RmVimball| command. +To uninstall, use the |:RmVimball| command. DEPENDENCIES *camelcasemotion-dependencies* -- Requires Vim 7.0 or higher. +- Requires Vim 7.0 or higher. ============================================================================== CONFIGURATION *camelcasemotion-configuration* If you want to use different mappings, map your keys to the <Plug>CamelCaseMotion_? mapping targets _before_ sourcing this script (e.g. in -your |vimrc|). +your |vimrc|). EXAMPLE: Replace the default |w|, |b| and |e| mappings instead of defining additional mappings |<leader>w|, |<leader>b| and |<leader>e|: > map <silent> w <Plug>CamelCaseMotion_w map <silent> b <Plug>CamelCaseMotion_b map <silent> e <Plug>CamelCaseMotion_e + map <silent> ge <Plug>CamelCaseMotion_ge sunmap w sunmap b sunmap e + sunmap ge EXAMPLE: Replace default |iw| text-object and define |ib| and |ie| motions: > omap <silent> iw <Plug>CamelCaseMotion_iw @@ -118,16 +120,16 @@ KNOWN PROBLEMS *camelcasemotion-known-problems* the operator-pending and visual mode <leader>e mapping if 'selection' is not set to "exclusive". It'll skip "P" and select "P1" in one step. As a workaround, use |<leader>w| instead of |<leader>e|; those two mappings have - the same effect inside CamelCaseWords, anyway. + the same effect inside CamelCaseWords, anyway. - The operator-pending and visual mode |<leader>e| mapping doesn't work properly when it reaches the end of the buffer; the final character of the moved-over "word" remains. As a workaround, use the default 'e' motion - instead of '<leader>e'. + instead of '<leader>e'. - When the Vim setting 'selection' is not set to "exclusive", a forward-backward combination in visual mode (e.g. 'v<leader>w<leader>b') selects one additional character to the left, instead of only the character where the motion started. Likewise, extension of the visual selection from - the front end is off by one additional character. + the front end is off by one additional character. ============================================================================== TODO *camelcasemotion-todo* @@ -138,9 +140,9 @@ HISTORY *camelcasemotion-history* 1.50 05-May-2009 - Do not create mappings for select mode; according to |Select-mode|, printable character commands should delete the selection and insert the - typed characters. Now using :xmap to only target visual mode. -- Moved functions from plugin to separate autoload script. -- Split off documentation into separate help file. + typed characters. Now using :xmap to only target visual mode. +- Moved functions from plugin to separate autoload script. +- Split off documentation into separate help file. 1.40 30-Jun-2008 BF: Now using :normal! to be independent from any user mappings. Thanks to @@ -159,30 +161,30 @@ The motions now also stop at non-keyword boundaries, just like the regular motions. This has no effect inside a CamelCaseWord or inside underscore_notation, but it makes the motions behave like the regular motions (which is important if you replace the default motions). Thanks to Mun Johl -for reporting this. +for reporting this. 1.30 09-Apr-2008 - Allowing users to use mappings different than ,w ,b ,e by defining <Plug>CamelCaseMotion_? target mappings. This can even be used to replace the default 'w', 'b' and 'e' mappings, as suggested by Mun Johl. -- Now requires VIM 7.0 or higher. +- Now requires VIM 7.0 or higher. 1.20 29-May-2007 ENH: The visual mode motions now also (mostly) work with the (default) setting -'set selection=inclusive', instead of selecting one character too much. +'set selection=inclusive', instead of selecting one character too much. 1.10 28-May-2007 -Incorporated major improvements and simplifications done by Joseph Barker. +Incorporated major improvements and simplifications done by Joseph Barker. 1.00 22-May-2007 -First published version. +First published version. 0.01 11-Oct-2005 -Started development based on vimtip #1016 by Anthony Van Ham. +Started development based on vimtip #1016 by Anthony Van Ham. ============================================================================== Copyright: (C) 2007-2009 by Ingo Karkat -The VIM LICENSE applies to this script; see|copyright|. +The VIM LICENSE applies to this script; see|copyright|. Maintainer: Ingo Karkat <ingo@karkat.de> ============================================================================== |