vim-python-ide / .vim / doc / surround.txt

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 *surround.txt* Plugin for deleting, changing, and adding "surroundings" Author: Tim Pope *surround-author* License: Same terms as Vim itself (see |license|) This plugin is only available if 'compatible' is not set. INTRODUCTION *surround* This plugin is a tool for dealing with pairs of "surroundings." Examples of surroundings include parentheses, quotes, and HTML tags. They are closely related to what Vim refers to as |text-objects|. Provided are mappings to allow for removing, changing, and adding surroundings. Details follow on the exact semantics, but first, consider the following examples. An asterisk (*) is used to denote the cursor position. Old text Command New text ~ "Hello *world!" ds" Hello world! [123+4*56]/2 cs]) (123+456)/2 "Look ma, I'm *HTML!" cs" Look ma, I'm HTML! if *x>3 { ysW( if ( x>3 ) { my $str = *whee!; vlllls' my$str = 'whee!'; While a few features of this plugin will work in older versions of Vim, Vim 7 is recommended for full functionality. MAPPINGS *surround-mappings* Delete surroundings is *ds* . The next character given determines the target to delete. The exact nature of the target are explained in |surround-targets| but essentially it is the last character of a |text-object|. This mapping deletes the difference between the "inner" object and "an" object. This is easiest to understand with some examples: Old text Command New text ~ "Hello *world!" ds" Hello world! (123+4*56)/2 ds) 123+456/2
Yo!*
dst Yo! Change surroundings is *cs* . It takes two arguments, a target like with |ds|, and a replacement. Details about the second argument can be found below in |surround-replacements|. Once again, examples are in order. Old text Command New text ~ "Hello *world!" cs"' 'Hello world!' "Hello *world!" cs" Hello world! (123+4*56)/2 cs)] [123+456]/2 (123+4*56)/2 cs)[ [ 123+456 ]/2
Yo!*
cst

Yo!

" < Inputting text replacements is a proof of concept at this point. The ugly, unintuitive interface and the brevity of the documentation reflect this. Finally, It is possible to always append a string to surroundings in insert mode (and only insert mode). This is useful with certain plugins and mappings that allow you to jump to such markings. > let g:surround_insert_tail = "<++>" < ISSUES *surround-issues* Vim could potentially get confused when deleting/changing occurs at the very end of the line. Please report any repeatable instances of this. Do we need to use |inputsave()|/|inputrestore()| with the tag replacement? Indenting is handled haphazardly. Need to decide the most appropriate behavior and implement it. Right now one can do :let b:surround_indent = 1 (or the global equivalent) to enable automatic re-indenting by Vim via |=|; should this be the default? vim:tw=78:ts=8:ft=help:norl: `