Mercurial > vim
annotate runtime/doc/insert.txt @ 15416:5f8ddd2a7b92 v8.1.0716
patch 8.1.0716: get warning message when 'completefunc' returns nothing
commit https://github.com/vim/vim/commit/cee9bc2e3dc5c16a9d2a8d0e23aa0d5fdefa3a4a
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri Jan 11 13:02:23 2019 +0100
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Problem: Get warning message when 'completefunc' returns nothing.
Solution: Allow for returning v:none to suppress the warning message.
(Yasuhiro Matsumoto, closes #3789)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Fri, 11 Jan 2019 13:15:06 +0100 |
| parents | 0ecb909e3249 |
| children | f0f06837a699 |
| rev | line source |
|---|---|
| 13963 | 1 *insert.txt* For Vim version 8.1. Last change: 2018 Feb 10 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 *Insert* *Insert-mode* | |
| 8 Inserting and replacing text *mode-ins-repl* | |
| 9 | |
| 10 Most of this file is about Insert and Replace mode. At the end are a few | |
| 11 commands for inserting text in other ways. | |
| 12 | |
| 13 An overview of the most often used commands can be found in chapter 24 of the | |
| 14 user manual |usr_24.txt|. | |
| 15 | |
| 16 1. Special keys |ins-special-keys| | |
| 17 2. Special special keys |ins-special-special| | |
| 18 3. 'textwidth' and 'wrapmargin' options |ins-textwidth| | |
| 19 4. 'expandtab', 'smarttab' and 'softtabstop' options |ins-expandtab| | |
| 20 5. Replace mode |Replace-mode| | |
| 21 6. Virtual Replace mode |Virtual-Replace-mode| | |
| 22 7. Insert mode completion |ins-completion| | |
| 23 8. Insert mode commands |inserting| | |
| 24 9. Ex insert commands |inserting-ex| | |
| 25 10. Inserting a file |inserting-file| | |
| 26 | |
| 27 Also see 'virtualedit', for moving the cursor to positions where there is no | |
| 28 character. Useful for editing a table. | |
| 29 | |
| 30 ============================================================================== | |
| 31 1. Special keys *ins-special-keys* | |
| 32 | |
| 33 In Insert and Replace mode, the following characters have a special meaning; | |
| 34 other characters are inserted directly. To insert one of these special | |
| 35 characters into the buffer, precede it with CTRL-V. To insert a <Nul> | |
| 36 character use "CTRL-V CTRL-@" or "CTRL-V 000". On some systems, you have to | |
| 37 use "CTRL-V 003" to insert a CTRL-C. Note: When CTRL-V is mapped you can | |
| 38 often use CTRL-Q instead |i_CTRL-Q|. | |
| 39 | |
| 40 If you are working in a special language mode when inserting text, see the | |
| 41 'langmap' option, |'langmap'|, on how to avoid switching this mode on and off | |
| 42 all the time. | |
| 43 | |
| 44 If you have 'insertmode' set, <Esc> and a few other keys get another meaning. | |
| 45 See |'insertmode'|. | |
| 46 | |
| 47 char action ~ | |
| 48 ----------------------------------------------------------------------- | |
| 49 *i_CTRL-[* *i_<Esc>* | |
| 50 <Esc> or CTRL-[ End insert or Replace mode, go back to Normal mode. Finish | |
| 51 abbreviation. | |
| 52 Note: If your <Esc> key is hard to hit on your keyboard, train | |
| 53 yourself to use CTRL-[. | |
| 6153 | 54 If Esc doesn't work and you are using a Mac, try CTRL-Esc. |
| 55 Or disable Listening under Accessibility preferences. | |
| 7 | 56 *i_CTRL-C* |
| 57 CTRL-C Quit insert mode, go back to Normal mode. Do not check for | |
| 140 | 58 abbreviations. Does not trigger the |InsertLeave| autocommand |
| 59 event. | |
| 7 | 60 |
| 61 *i_CTRL-@* | |
| 62 CTRL-@ Insert previously inserted text and stop insert. {Vi: only | |
| 63 when typed as first char, only up to 128 chars} | |
| 64 *i_CTRL-A* | |
| 65 CTRL-A Insert previously inserted text. {not in Vi} | |
| 66 | |
| 67 *i_CTRL-H* *i_<BS>* *i_BS* | |
| 68 <BS> or CTRL-H Delete the character before the cursor (see |i_backspacing| | |
| 69 about joining lines). | |
| 70 See |:fixdel| if your <BS> key does not do what you want. | |
| 71 {Vi: does not delete autoindents} | |
| 72 *i_<Del>* *i_DEL* | |
| 73 <Del> Delete the character under the cursor. If the cursor is at | |
| 74 the end of the line, and the 'backspace' option includes | |
| 75 "eol", delete the <EOL>; the next line is appended after the | |
| 76 current one. | |
| 77 See |:fixdel| if your <Del> key does not do what you want. | |
| 78 {not in Vi} | |
| 79 *i_CTRL-W* | |
| 80 CTRL-W Delete the word before the cursor (see |i_backspacing| about | |
| 81 joining lines). See the section "word motions", | |
| 82 |word-motions|, for the definition of a word. | |
| 83 *i_CTRL-U* | |
| 6823 | 84 CTRL-U Delete all entered characters before the cursor in the current |
| 6884 | 85 line. If there are no newly entered characters and |
| 86 'backspace' is not empty, delete all characters before the | |
| 6823 | 87 cursor in the current line. |
| 88 See |i_backspacing| about joining lines. | |
| 7 | 89 *i_CTRL-I* *i_<Tab>* *i_Tab* |
| 90 <Tab> or CTRL-I Insert a tab. If the 'expandtab' option is on, the | |
| 91 equivalent number of spaces is inserted (use CTRL-V <Tab> to | |
| 92 avoid the expansion; use CTRL-Q <Tab> if CTRL-V is mapped | |
| 93 |i_CTRL-Q|). See also the 'smarttab' option and | |
| 94 |ins-expandtab|. | |
| 95 *i_CTRL-J* *i_<NL>* | |
| 96 <NL> or CTRL-J Begin new line. | |
| 97 *i_CTRL-M* *i_<CR>* | |
| 98 <CR> or CTRL-M Begin new line. | |
| 99 *i_CTRL-K* | |
| 100 CTRL-K {char1} [char2] | |
| 101 Enter digraph (see |digraphs|). When {char1} is a special | |
| 102 key, the code for that key is inserted in <> form. For | |
| 103 example, the string "<S-Space>" can be entered by typing | |
| 104 <C-K><S-Space> (two keys). Neither char is considered for | |
| 105 mapping. {not in Vi} | |
| 106 | |
| 107 CTRL-N Find next keyword (see |i_CTRL-N|). {not in Vi} | |
| 108 CTRL-P Find previous keyword (see |i_CTRL-P|). {not in Vi} | |
| 109 | |
| 110 CTRL-R {0-9a-z"%#*+:.-=} *i_CTRL-R* | |
| 111 Insert the contents of a register. Between typing CTRL-R and | |
| 112 the second character, '"' will be displayed to indicate that | |
| 113 you are expected to enter the name of a register. | |
| 114 The text is inserted as if you typed it, but mappings and | |
| 115 abbreviations are not used. If you have options like | |
| 116 'textwidth', 'formatoptions', or 'autoindent' set, this will | |
| 117 influence what will be inserted. This is different from what | |
| 118 happens with the "p" command and pasting with the mouse. | |
| 119 Special registers: | |
| 120 '"' the unnamed register, containing the text of | |
| 121 the last delete or yank | |
| 122 '%' the current file name | |
| 123 '#' the alternate file name | |
| 124 '*' the clipboard contents (X11: primary selection) | |
| 125 '+' the clipboard contents | |
| 126 '/' the last search pattern | |
| 127 ':' the last command-line | |
| 128 '.' the last inserted text | |
| 129 '-' the last small (less than a line) delete | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
130 *i_CTRL-R_=* |
| 7 | 131 '=' the expression register: you are prompted to |
| 132 enter an expression (see |expression|) | |
| 36 | 133 Note that 0x80 (128 decimal) is used for |
| 667 | 134 special keys. E.g., you can use this to move |
| 135 the cursor up: | |
| 136 CTRL-R ="\<Up>" | |
| 137 Use CTRL-R CTRL-R to insert text literally. | |
| 714 | 138 When the result is a |List| the items are used |
| 139 as lines. They can have line breaks inside | |
| 140 too. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
141 When the result is a Float it's automatically |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
142 converted to a String. |
|
5130
71e066e10a47
updated for version 7.3.1308
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
143 When append() or setline() is invoked the undo |
|
71e066e10a47
updated for version 7.3.1308
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
144 sequence will be broken. |
| 7 | 145 See |registers| about registers. {not in Vi} |
| 146 | |
| 147 CTRL-R CTRL-R {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-R* | |
| 148 Insert the contents of a register. Works like using a single | |
| 149 CTRL-R, but the text is inserted literally, not as if typed. | |
| 150 This differs when the register contains characters like <BS>. | |
| 151 Example, where register a contains "ab^Hc": > | |
| 152 CTRL-R a results in "ac". | |
| 153 CTRL-R CTRL-R a results in "ab^Hc". | |
| 154 < Options 'textwidth', 'formatoptions', etc. still apply. If | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
155 you also want to avoid these, use CTRL-R CTRL-O, see below. |
| 7 | 156 The '.' register (last inserted text) is still inserted as |
| 157 typed. {not in Vi} | |
| 158 | |
| 159 CTRL-R CTRL-O {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-O* | |
| 160 Insert the contents of a register literally and don't | |
| 161 auto-indent. Does the same as pasting with the mouse | |
| 11347 | 162 |<MiddleMouse>|. When the register is linewise this will |
| 163 insert the text above the current line, like with `P`. | |
| 7 | 164 Does not replace characters! |
| 165 The '.' register (last inserted text) is still inserted as | |
| 166 typed. {not in Vi} | |
| 167 | |
| 168 CTRL-R CTRL-P {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-P* | |
| 169 Insert the contents of a register literally and fix the | |
| 170 indent, like |[<MiddleMouse>|. | |
| 171 Does not replace characters! | |
| 172 The '.' register (last inserted text) is still inserted as | |
| 173 typed. {not in Vi} | |
| 174 | |
| 175 *i_CTRL-T* | |
| 176 CTRL-T Insert one shiftwidth of indent at the start of the current | |
| 177 line. The indent is always rounded to a 'shiftwidth' (this is | |
| 178 vi compatible). {Vi: only when in indent} | |
| 179 *i_CTRL-D* | |
| 180 CTRL-D Delete one shiftwidth of indent at the start of the current | |
| 181 line. The indent is always rounded to a 'shiftwidth' (this is | |
| 182 vi compatible). {Vi: CTRL-D works only when used after | |
| 183 autoindent} | |
| 184 *i_0_CTRL-D* | |
| 185 0 CTRL-D Delete all indent in the current line. {Vi: CTRL-D works | |
| 186 only when used after autoindent} | |
| 187 *i_^_CTRL-D* | |
| 188 ^ CTRL-D Delete all indent in the current line. The indent is | |
| 189 restored in the next line. This is useful when inserting a | |
| 190 label. {Vi: CTRL-D works only when used after autoindent} | |
| 191 | |
| 192 *i_CTRL-V* | |
| 193 CTRL-V Insert next non-digit literally. For special keys, the | |
| 194 terminal code is inserted. It's also possible to enter the | |
| 195 decimal, octal or hexadecimal value of a character | |
| 196 |i_CTRL-V_digit|. | |
| 197 The characters typed right after CTRL-V are not considered for | |
| 198 mapping. {Vi: no decimal byte entry} | |
| 199 Note: When CTRL-V is mapped (e.g., to paste text) you can | |
| 200 often use CTRL-Q instead |i_CTRL-Q|. | |
| 201 | |
| 202 *i_CTRL-Q* | |
| 203 CTRL-Q Same as CTRL-V. | |
| 204 Note: Some terminal connections may eat CTRL-Q, it doesn't | |
| 205 work then. It does work in the GUI. | |
| 206 | |
| 207 CTRL-X Enter CTRL-X mode. This is a sub-mode where commands can | |
| 236 | 208 be given to complete words or scroll the window. See |
| 7 | 209 |i_CTRL-X| and |ins-completion|. {not in Vi} |
| 210 | |
| 211 *i_CTRL-E* | |
| 212 CTRL-E Insert the character which is below the cursor. {not in Vi} | |
| 213 *i_CTRL-Y* | |
| 214 CTRL-Y Insert the character which is above the cursor. {not in Vi} | |
| 215 Note that for CTRL-E and CTRL-Y 'textwidth' is not used, to be | |
| 216 able to copy characters from a long line. | |
| 217 | |
| 218 *i_CTRL-_* | |
| 219 CTRL-_ Switch between languages, as follows: | |
| 220 - When in a rightleft window, revins and nohkmap are toggled, | |
| 221 since English will likely be inserted in this case. | |
| 222 - When in a norightleft window, revins and hkmap are toggled, | |
| 223 since Hebrew will likely be inserted in this case. | |
| 224 | |
| 225 CTRL-_ moves the cursor to the end of the typed text. | |
| 226 | |
| 227 This command is only available when the 'allowrevins' option | |
| 228 is set. | |
| 229 Please refer to |rileft.txt| for more information about | |
| 230 right-to-left mode. | |
| 231 {not in Vi} | |
| 1121 | 232 Only if compiled with the |+rightleft| feature. |
| 233 | |
| 7 | 234 *i_CTRL-^* |
| 235 CTRL-^ Toggle the use of typing language characters. | |
| 236 When language |:lmap| mappings are defined: | |
| 237 - If 'iminsert' is 1 (langmap mappings used) it becomes 0 (no | |
| 238 langmap mappings used). | |
| 239 - If 'iminsert' has another value it becomes 1, thus langmap | |
| 240 mappings are enabled. | |
| 241 When no language mappings are defined: | |
| 242 - If 'iminsert' is 2 (Input Method used) it becomes 0 (no | |
| 243 Input Method used). | |
| 244 - If 'iminsert' has another value it becomes 2, thus the Input | |
| 245 Method is enabled. | |
| 246 When set to 1, the value of the "b:keymap_name" variable, the | |
| 247 'keymap' option or "<lang>" appears in the status line. | |
| 248 The language mappings are normally used to type characters | |
| 249 that are different from what the keyboard produces. The | |
| 250 'keymap' option can be used to install a whole number of them. | |
| 251 {not in Vi} | |
| 252 | |
| 253 *i_CTRL-]* | |
| 254 CTRL-] Trigger abbreviation, without inserting a character. {not in | |
| 255 Vi} | |
| 256 | |
| 257 *i_<Insert>* | |
| 258 <Insert> Toggle between Insert and Replace mode. {not in Vi} | |
| 259 ----------------------------------------------------------------------- | |
| 260 | |
| 261 *i_backspacing* | |
| 262 The effect of the <BS>, CTRL-W, and CTRL-U depend on the 'backspace' option | |
| 263 (unless 'revins' is set). This is a comma separated list of items: | |
| 264 | |
| 265 item action ~ | |
| 266 indent allow backspacing over autoindent | |
| 267 eol allow backspacing over end-of-line (join lines) | |
| 268 start allow backspacing over the start position of insert; CTRL-W and | |
| 269 CTRL-U stop once at the start position | |
| 270 | |
| 271 When 'backspace' is empty, Vi compatible backspacing is used. You cannot | |
| 272 backspace over autoindent, before column 1 or before where insert started. | |
| 273 | |
| 274 For backwards compatibility the values "0", "1" and "2" are also allowed, see | |
| 275 |'backspace'|. | |
| 276 | |
| 277 If the 'backspace' option does contain "eol" and the cursor is in column 1 | |
| 278 when one of the three keys is used, the current line is joined with the | |
| 279 previous line. This effectively deletes the <EOL> in front of the cursor. | |
| 280 {Vi: does not cross lines, does not delete past start position of insert} | |
| 281 | |
| 282 *i_CTRL-V_digit* | |
| 283 With CTRL-V the decimal, octal or hexadecimal value of a character can be | |
| 284 entered directly. This way you can enter any character, except a line break | |
| 285 (<NL>, value 10). There are five ways to enter the character value: | |
| 286 | |
| 287 first char mode max nr of chars max value ~ | |
| 288 (none) decimal 3 255 | |
| 236 | 289 o or O octal 3 377 (255) |
| 7 | 290 x or X hexadecimal 2 ff (255) |
| 291 u hexadecimal 4 ffff (65535) | |
| 292 U hexadecimal 8 7fffffff (2147483647) | |
| 293 | |
| 294 Normally you would type the maximum number of characters. Thus to enter a | |
| 295 space (value 32) you would type <C-V>032. You can omit the leading zero, in | |
| 296 which case the character typed after the number must be a non-digit. This | |
| 297 happens for the other modes as well: As soon as you type a character that is | |
| 298 invalid for the mode, the value before it will be used and the "invalid" | |
| 299 character is dealt with in the normal way. | |
| 300 | |
| 301 If you enter a value of 10, it will end up in the file as a 0. The 10 is a | |
| 302 <NL>, which is used internally to represent the <Nul> character. When writing | |
| 303 the buffer to a file, the <NL> character is translated into <Nul>. The <NL> | |
| 304 character is written at the end of each line. Thus if you want to insert a | |
| 305 <NL> character in a file you will have to make a line break. | |
| 306 | |
| 307 *i_CTRL-X* *insert_expand* | |
| 308 CTRL-X enters a sub-mode where several commands can be used. Most of these | |
| 309 commands do keyword completion; see |ins-completion|. These are not available | |
| 310 when Vim was compiled without the |+insert_expand| feature. | |
| 311 | |
| 312 Two commands can be used to scroll the window up or down, without exiting | |
| 313 insert mode: | |
| 314 | |
| 315 *i_CTRL-X_CTRL-E* | |
| 316 CTRL-X CTRL-E scroll window one line up. | |
| 816 | 317 When doing completion look here: |complete_CTRL-E| |
| 7 | 318 |
| 319 *i_CTRL-X_CTRL-Y* | |
| 320 CTRL-X CTRL-Y scroll window one line down. | |
| 816 | 321 When doing completion look here: |complete_CTRL-Y| |
| 7 | 322 |
| 323 After CTRL-X is pressed, each CTRL-E (CTRL-Y) scrolls the window up (down) by | |
| 324 one line unless that would cause the cursor to move from its current position | |
| 325 in the file. As soon as another key is pressed, CTRL-X mode is exited and | |
| 326 that key is interpreted as in Insert mode. | |
| 327 | |
| 328 | |
| 329 ============================================================================== | |
| 330 2. Special special keys *ins-special-special* | |
| 331 | |
| 332 The following keys are special. They stop the current insert, do something, | |
| 333 and then restart insertion. This means you can do something without getting | |
| 334 out of Insert mode. This is very handy if you prefer to use the Insert mode | |
| 335 all the time, just like editors that don't have a separate Normal mode. You | |
| 336 may also want to set the 'backspace' option to "indent,eol,start" and set the | |
| 337 'insertmode' option. You can use CTRL-O if you want to map a function key to | |
| 338 a command. | |
| 339 | |
| 340 The changes (inserted or deleted characters) before and after these keys can | |
| 341 be undone separately. Only the last change can be redone and always behaves | |
| 342 like an "i" command. | |
| 343 | |
| 344 char action ~ | |
| 345 ----------------------------------------------------------------------- | |
| 346 <Up> cursor one line up *i_<Up>* | |
| 347 <Down> cursor one line down *i_<Down>* | |
| 348 CTRL-G <Up> cursor one line up, insert start column *i_CTRL-G_<Up>* | |
| 349 CTRL-G k cursor one line up, insert start column *i_CTRL-G_k* | |
| 350 CTRL-G CTRL-K cursor one line up, insert start column *i_CTRL-G_CTRL-K* | |
| 351 CTRL-G <Down> cursor one line down, insert start column *i_CTRL-G_<Down>* | |
| 352 CTRL-G j cursor one line down, insert start column *i_CTRL-G_j* | |
| 353 CTRL-G CTRL-J cursor one line down, insert start column *i_CTRL-G_CTRL-J* | |
| 354 <Left> cursor one character left *i_<Left>* | |
| 355 <Right> cursor one character right *i_<Right>* | |
| 356 <S-Left> cursor one word back (like "b" command) *i_<S-Left>* | |
| 357 <C-Left> cursor one word back (like "b" command) *i_<C-Left>* | |
| 358 <S-Right> cursor one word forward (like "w" command) *i_<S-Right>* | |
| 359 <C-Right> cursor one word forward (like "w" command) *i_<C-Right>* | |
| 360 <Home> cursor to first char in the line *i_<Home>* | |
| 361 <End> cursor to after last char in the line *i_<End>* | |
| 362 <C-Home> cursor to first char in the file *i_<C-Home>* | |
| 363 <C-End> cursor to after last char in the file *i_<C-End>* | |
| 364 <LeftMouse> cursor to position of mouse click *i_<LeftMouse>* | |
| 365 <S-Up> move window one page up *i_<S-Up>* | |
| 366 <PageUp> move window one page up *i_<PageUp>* | |
| 367 <S-Down> move window one page down *i_<S-Down>* | |
| 368 <PageDown> move window one page down *i_<PageDown>* | |
|
2409
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
369 <ScrollWheelDown> move window three lines down *i_<ScrollWheelDown>* |
|
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
370 <S-ScrollWheelDown> move window one page down *i_<S-ScrollWheelDown>* |
|
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
371 <ScrollWheelUp> move window three lines up *i_<ScrollWheelUp>* |
|
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
372 <S-ScrollWheelUp> move window one page up *i_<S-ScrollWheelUp>* |
|
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
373 <ScrollWheelLeft> move window six columns left *i_<ScrollWheelLeft>* |
|
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
374 <S-ScrollWheelLeft> move window one page left *i_<S-ScrollWheelLeft>* |
|
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
375 <ScrollWheelRight> move window six columns right *i_<ScrollWheelRight>* |
|
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
376 <S-ScrollWheelRight> move window one page right *i_<S-ScrollWheelRight>* |
| 7 | 377 CTRL-O execute one command, return to Insert mode *i_CTRL-O* |
| 625 | 378 CTRL-\ CTRL-O like CTRL-O but don't move the cursor *i_CTRL-\_CTRL-O* |
| 477 | 379 CTRL-L when 'insertmode' is set: go to Normal mode *i_CTRL-L* |
| 7 | 380 CTRL-G u break undo sequence, start new change *i_CTRL-G_u* |
|
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
381 CTRL-G U don't break undo with next left/right cursor *i_CTRL-G_U* |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
382 movement (but only if the cursor stays |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
383 within same the line) |
| 7 | 384 ----------------------------------------------------------------------- |
| 385 | |
| 386 Note: If the cursor keys take you out of Insert mode, check the 'noesckeys' | |
| 387 option. | |
| 388 | |
| 389 The CTRL-O command sometimes has a side effect: If the cursor was beyond the | |
| 390 end of the line, it will be put on the last character in the line. In | |
| 391 mappings it's often better to use <Esc> (first put an "x" in the text, <Esc> | |
| 477 | 392 will then always put the cursor on it). Or use CTRL-\ CTRL-O, but then |
| 4073 | 393 beware of the cursor possibly being beyond the end of the line. Note that the |
| 394 command following CTRL-\ CTRL-O can still move the cursor, it is not restored | |
| 395 to its original position. | |
| 7 | 396 |
| 2625 | 397 The CTRL-O command takes you to Normal mode. If you then use a command enter |
| 3492 | 398 Insert mode again it normally doesn't nest. Thus when typing "a<C-O>a" and |
| 399 then <Esc> takes you back to Normal mode, you do not need to type <Esc> twice. | |
| 400 An exception is when not typing the command, e.g. when executing a mapping or | |
| 401 sourcing a script. This makes mappings work that briefly switch to Insert | |
| 402 mode. | |
| 2625 | 403 |
| 7 | 404 The shifted cursor keys are not available on all terminals. |
| 405 | |
| 406 Another side effect is that a count specified before the "i" or "a" command is | |
| 407 ignored. That is because repeating the effect of the command after CTRL-O is | |
| 408 too complicated. | |
| 409 | |
| 410 An example for using CTRL-G u: > | |
| 411 | |
| 412 :inoremap <C-H> <C-G>u<C-H> | |
| 413 | |
| 414 This redefines the backspace key to start a new undo sequence. You can now | |
| 415 undo the effect of the backspace key, without changing what you typed before | |
| 3456 | 416 that, with CTRL-O u. Another example: > |
| 417 | |
| 418 :inoremap <CR> <C-]><C-G>u<CR> | |
| 419 | |
| 420 This breaks undo at each line break. It also expands abbreviations before | |
| 421 this. | |
| 7 | 422 |
|
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
423 An example for using CTRL-G U: > |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
424 |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
425 inoremap <Left> <C-G>U<Left> |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
426 inoremap <Right> <C-G>U<Right> |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
427 inoremap <expr> <Home> col('.') == match(getline('.'), '\S') + 1 ? |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
428 \ repeat('<C-G>U<Left>', col('.') - 1) : |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
429 \ (col('.') < match(getline('.'), '\S') ? |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
430 \ repeat('<C-G>U<Right>', match(getline('.'), '\S') + 0) : |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
431 \ repeat('<C-G>U<Left>', col('.') - 1 - match(getline('.'), '\S'))) |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
432 inoremap <expr> <End> repeat('<C-G>U<Right>', col('$') - col('.')) |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
433 inoremap ( ()<C-G>U<Left> |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
434 |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
435 This makes it possible to use the cursor keys in Insert mode, without breaking |
| 13125 | 436 the undo sequence and therefore using |.| (redo) will work as expected. |
| 14123 | 437 Also entering a text like (with the "(" mapping from above): |
|
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
438 |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
439 Lorem ipsum (dolor |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
440 |
| 14123 | 441 will be repeatable by using |.| to the expected |
|
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
442 |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
443 Lorem ipsum (dolor) |
|
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
444 |
| 10 | 445 Using CTRL-O splits undo: the text typed before and after it is undone |
| 446 separately. If you want to avoid this (e.g., in a mapping) you might be able | |
| 447 to use CTRL-R = |i_CTRL-R|. E.g., to call a function: > | |
| 448 :imap <F2> <C-R>=MyFunc()<CR> | |
| 449 | |
| 7 | 450 When the 'whichwrap' option is set appropriately, the <Left> and <Right> |
| 451 keys on the first/last character in the line make the cursor wrap to the | |
| 452 previous/next line. | |
| 453 | |
| 454 The CTRL-G j and CTRL-G k commands can be used to insert text in front of a | |
| 455 column. Example: > | |
| 456 int i; | |
| 457 int j; | |
| 236 | 458 Position the cursor on the first "int", type "istatic <C-G>j ". The |
| 7 | 459 result is: > |
| 460 static int i; | |
| 461 int j; | |
| 462 When inserting the same text in front of the column in every line, use the | |
| 463 Visual blockwise command "I" |v_b_I|. | |
| 464 | |
| 465 ============================================================================== | |
| 466 3. 'textwidth' and 'wrapmargin' options *ins-textwidth* | |
| 467 | |
| 468 The 'textwidth' option can be used to automatically break a line before it | |
| 469 gets too long. Set the 'textwidth' option to the desired maximum line | |
| 470 length. If you then type more characters (not spaces or tabs), the | |
| 471 last word will be put on a new line (unless it is the only word on the | |
| 472 line). If you set 'textwidth' to 0, this feature is disabled. | |
| 473 | |
| 474 The 'wrapmargin' option does almost the same. The difference is that | |
| 475 'textwidth' has a fixed width while 'wrapmargin' depends on the width of the | |
| 476 screen. When using 'wrapmargin' this is equal to using 'textwidth' with a | |
| 477 value equal to (columns - 'wrapmargin'), where columns is the width of the | |
| 478 screen. | |
| 479 | |
| 480 When 'textwidth' and 'wrapmargin' are both set, 'textwidth' is used. | |
| 481 | |
| 482 If you don't really want to break the line, but view the line wrapped at a | |
| 483 convenient place, see the 'linebreak' option. | |
| 484 | |
| 667 | 485 The line is only broken automatically when using Insert mode, or when |
| 7 | 486 appending to a line. When in replace mode and the line length is not |
| 487 changed, the line will not be broken. | |
| 488 | |
| 489 Long lines are broken if you enter a non-white character after the margin. | |
| 490 The situations where a line will be broken can be restricted by adding | |
| 491 characters to the 'formatoptions' option: | |
| 492 "l" Only break a line if it was not longer than 'textwidth' when the insert | |
| 493 started. | |
| 494 "v" Only break at a white character that has been entered during the | |
| 495 current insert command. This is mostly Vi-compatible. | |
| 496 "lv" Only break if the line was not longer than 'textwidth' when the insert | |
| 497 started and only at a white character that has been entered during the | |
| 498 current insert command. Only differs from "l" when entering non-white | |
| 499 characters while crossing the 'textwidth' boundary. | |
| 500 | |
| 667 | 501 Normally an internal function will be used to decide where to break the line. |
| 502 If you want to do it in a different way set the 'formatexpr' option to an | |
| 503 expression that will take care of the line break. | |
| 504 | |
| 7 | 505 If you want to format a block of text, you can use the "gq" operator. Type |
| 506 "gq" and a movement command to move the cursor to the end of the block. In | |
| 507 many cases, the command "gq}" will do what you want (format until the end of | |
| 508 paragraph). Alternatively, you can use "gqap", which will format the whole | |
| 509 paragraph, no matter where the cursor currently is. Or you can use Visual | |
| 510 mode: hit "v", move to the end of the block, and type "gq". See also |gq|. | |
| 511 | |
| 512 ============================================================================== | |
| 513 4. 'expandtab', 'smarttab' and 'softtabstop' options *ins-expandtab* | |
| 514 | |
| 515 If the 'expandtab' option is on, spaces will be used to fill the amount of | |
| 516 whitespace of the tab. If you want to enter a real <Tab>, type CTRL-V first | |
| 517 (use CTRL-Q when CTRL-V is mapped |i_CTRL-Q|). | |
| 518 The 'expandtab' option is off by default. Note that in Replace mode, a single | |
| 519 character is replaced with several spaces. The result of this is that the | |
| 520 number of characters in the line increases. Backspacing will delete one | |
| 521 space at a time. The original character will be put back for only one space | |
| 522 that you backspace over (the last one). {Vi does not have the 'expandtab' | |
| 523 option} | |
| 524 | |
| 525 *ins-smarttab* | |
| 526 When the 'smarttab' option is on, a <Tab> inserts 'shiftwidth' positions at | |
| 527 the beginning of a line and 'tabstop' positions in other places. This means | |
| 3682 | 528 that often spaces instead of a <Tab> character are inserted. When 'smarttab' |
| 7 | 529 is off, a <Tab> always inserts 'tabstop' positions, and 'shiftwidth' is only |
| 530 used for ">>" and the like. {not in Vi} | |
| 531 | |
| 532 *ins-softtabstop* | |
| 533 When the 'softtabstop' option is non-zero, a <Tab> inserts 'softtabstop' | |
| 534 positions, and a <BS> used to delete white space, will delete 'softtabstop' | |
| 535 positions. This feels like 'tabstop' was set to 'softtabstop', but a real | |
| 536 <Tab> character still takes 'tabstop' positions, so your file will still look | |
| 537 correct when used by other applications. | |
| 538 | |
| 539 If 'softtabstop' is non-zero, a <BS> will try to delete as much white space to | |
| 540 move to the previous 'softtabstop' position, except when the previously | |
| 541 inserted character is a space, then it will only delete the character before | |
| 542 the cursor. Otherwise you cannot always delete a single character before the | |
| 543 cursor. You will have to delete 'softtabstop' characters first, and then type | |
| 544 extra spaces to get where you want to be. | |
| 545 | |
| 546 ============================================================================== | |
| 547 5. Replace mode *Replace* *Replace-mode* *mode-replace* | |
| 548 | |
| 549 Enter Replace mode with the "R" command in normal mode. | |
| 550 | |
| 551 In Replace mode, one character in the line is deleted for every character you | |
| 552 type. If there is no character to delete (at the end of the line), the | |
| 553 typed character is appended (as in Insert mode). Thus the number of | |
| 554 characters in a line stays the same until you get to the end of the line. | |
| 555 If a <NL> is typed, a line break is inserted and no character is deleted. | |
| 556 | |
| 557 Be careful with <Tab> characters. If you type a normal printing character in | |
| 558 its place, the number of characters is still the same, but the number of | |
| 559 columns will become smaller. | |
| 560 | |
| 561 If you delete characters in Replace mode (with <BS>, CTRL-W, or CTRL-U), what | |
| 562 happens is that you delete the changes. The characters that were replaced | |
| 563 are restored. If you had typed past the existing text, the characters you | |
| 564 added are deleted. This is effectively a character-at-a-time undo. | |
| 565 | |
| 566 If the 'expandtab' option is on, a <Tab> will replace one character with | |
| 567 several spaces. The result of this is that the number of characters in the | |
| 568 line increases. Backspacing will delete one space at a time. The original | |
| 569 character will be put back for only one space that you backspace over (the | |
| 570 last one). {Vi does not have the 'expandtab' option} | |
| 571 | |
| 572 ============================================================================== | |
| 573 6. Virtual Replace mode *vreplace-mode* *Virtual-Replace-mode* | |
| 574 | |
| 575 Enter Virtual Replace mode with the "gR" command in normal mode. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
576 {not available when compiled without the |+vreplace| feature} |
| 7 | 577 {Vi does not have Virtual Replace mode} |
| 578 | |
| 579 Virtual Replace mode is similar to Replace mode, but instead of replacing | |
| 580 actual characters in the file, you are replacing screen real estate, so that | |
| 581 characters further on in the file never appear to move. | |
| 582 | |
| 583 So if you type a <Tab> it may replace several normal characters, and if you | |
| 584 type a letter on top of a <Tab> it may not replace anything at all, since the | |
| 585 <Tab> will still line up to the same place as before. | |
| 586 | |
| 587 Typing a <NL> still doesn't cause characters later in the file to appear to | |
| 588 move. The rest of the current line will be replaced by the <NL> (that is, | |
| 589 they are deleted), and replacing continues on the next line. A new line is | |
| 590 NOT inserted unless you go past the end of the file. | |
| 591 | |
| 592 Interesting effects are seen when using CTRL-T and CTRL-D. The characters | |
| 593 before the cursor are shifted sideways as normal, but characters later in the | |
| 594 line still remain still. CTRL-T will hide some of the old line under the | |
| 595 shifted characters, but CTRL-D will reveal them again. | |
| 596 | |
| 597 As with Replace mode, using <BS> etc will bring back the characters that were | |
| 598 replaced. This still works in conjunction with 'smartindent', CTRL-T and | |
| 599 CTRL-D, 'expandtab', 'smarttab', 'softtabstop', etc. | |
| 600 | |
| 601 In 'list' mode, Virtual Replace mode acts as if it was not in 'list' mode, | |
| 602 unless "L" is in 'cpoptions'. | |
| 603 | |
| 2581 | 604 Note that the only situations for which characters beyond the cursor should |
| 605 appear to move are in List mode |'list'|, and occasionally when 'wrap' is set | |
| 606 (and the line changes length to become shorter or wider than the width of the | |
| 607 screen). In other cases spaces may be inserted to avoid following characters | |
| 608 to move. | |
| 7 | 609 |
| 610 This mode is very useful for editing <Tab> separated columns in tables, for | |
| 611 entering new data while keeping all the columns aligned. | |
| 612 | |
| 613 ============================================================================== | |
| 614 7. Insert mode completion *ins-completion* | |
| 615 | |
| 449 | 616 In Insert and Replace mode, there are several commands to complete part of a |
| 7 | 617 keyword or line that has been typed. This is useful if you are using |
| 618 complicated keywords (e.g., function names with capitals and underscores). | |
| 619 | |
| 620 These commands are not available when the |+insert_expand| feature was | |
| 621 disabled at compile time. | |
| 622 | |
| 623 Completion can be done for: | |
| 624 | |
| 625 1. Whole lines |i_CTRL-X_CTRL-L| | |
| 626 2. keywords in the current file |i_CTRL-X_CTRL-N| | |
| 627 3. keywords in 'dictionary' |i_CTRL-X_CTRL-K| | |
| 628 4. keywords in 'thesaurus', thesaurus-style |i_CTRL-X_CTRL-T| | |
| 629 5. keywords in the current and included files |i_CTRL-X_CTRL-I| | |
| 630 6. tags |i_CTRL-X_CTRL-]| | |
| 631 7. file names |i_CTRL-X_CTRL-F| | |
| 632 8. definitions or macros |i_CTRL-X_CTRL-D| | |
| 633 9. Vim command-line |i_CTRL-X_CTRL-V| | |
| 449 | 634 10. User defined completion |i_CTRL-X_CTRL-U| |
| 523 | 635 11. omni completion |i_CTRL-X_CTRL-O| |
| 477 | 636 12. Spelling suggestions |i_CTRL-X_s| |
| 11473 | 637 13. keywords in 'complete' |i_CTRL-N| |i_CTRL-P| |
| 7 | 638 |
| 11473 | 639 All these, except CTRL-N and CTRL-P, are done in CTRL-X mode. This is a |
| 640 sub-mode of Insert and Replace modes. You enter CTRL-X mode by typing CTRL-X | |
| 641 and one of the CTRL-X commands. You exit CTRL-X mode by typing a key that is | |
| 642 not a valid CTRL-X mode command. Valid keys are the CTRL-X command itself, | |
| 643 CTRL-N (next), and CTRL-P (previous). | |
| 7 | 644 |
| 645 Also see the 'infercase' option if you want to adjust the case of the match. | |
| 646 | |
| 816 | 647 *complete_CTRL-E* |
| 648 When completion is active you can use CTRL-E to stop it and go back to the | |
| 843 | 649 originally typed text. The CTRL-E will not be inserted. |
| 816 | 650 |
| 651 *complete_CTRL-Y* | |
| 652 When the popup menu is displayed you can use CTRL-Y to stop completion and | |
| 653 accept the currently selected entry. The CTRL-Y is not inserted. Typing a | |
| 654 space, Enter, or some other unprintable character will leave completion mode | |
| 655 and insert that typed character. | |
| 656 | |
| 829 | 657 When the popup menu is displayed there are a few more special keys, see |
| 658 |popupmenu-keys|. | |
| 659 | |
| 7 | 660 Note: The keys that are valid in CTRL-X mode are not mapped. This allows for |
| 661 ":map ^F ^X^F" to work (where ^F is CTRL-F and ^X is CTRL-X). The key that | |
| 662 ends CTRL-X mode (any key that is not a valid CTRL-X mode command) is mapped. | |
| 663 Also, when doing completion with 'complete' mappings apply as usual. | |
| 664 | |
| 844 | 665 Note: While completion is active Insert mode can't be used recursively. |
| 666 Mappings that somehow invoke ":normal i.." will generate an E523 error. | |
| 667 | |
| 7 | 668 The following mappings are suggested to make typing the completion commands |
| 669 a bit easier (although they will hide other commands): > | |
| 670 :inoremap ^] ^X^] | |
| 671 :inoremap ^F ^X^F | |
| 672 :inoremap ^D ^X^D | |
| 673 :inoremap ^L ^X^L | |
| 674 | |
| 675 As a special case, typing CTRL-R to perform register insertion (see | |
| 676 |i_CTRL-R|) will not exit CTRL-X mode. This is primarily to allow the use of | |
| 677 the '=' register to call some function to determine the next operation. If | |
| 678 the contents of the register (or result of the '=' register evaluation) are | |
| 679 not valid CTRL-X mode keys, then CTRL-X mode will be exited as if those keys | |
| 680 had been typed. | |
| 681 | |
| 682 For example, the following will map <Tab> to either actually insert a <Tab> if | |
| 683 the current line is currently only whitespace, or start/continue a CTRL-N | |
| 684 completion operation: > | |
| 685 | |
| 686 function! CleverTab() | |
| 687 if strpart( getline('.'), 0, col('.')-1 ) =~ '^\s*$' | |
| 688 return "\<Tab>" | |
| 689 else | |
| 690 return "\<C-N>" | |
|
2120
f63ace015c63
Updated runtime and language files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
691 endif |
| 7 | 692 endfunction |
| 693 inoremap <Tab> <C-R>=CleverTab()<CR> | |
| 694 | |
| 695 | |
| 696 | |
| 697 Completing whole lines *compl-whole-line* | |
| 698 | |
| 699 *i_CTRL-X_CTRL-L* | |
| 700 CTRL-X CTRL-L Search backwards for a line that starts with the | |
| 459 | 701 same characters as those in the current line before |
| 702 the cursor. Indent is ignored. The matching line is | |
| 7 | 703 inserted in front of the cursor. |
| 459 | 704 The 'complete' option is used to decide which buffers |
| 667 | 705 are searched for a match. Both loaded and unloaded |
| 706 buffers are used. | |
| 7 | 707 CTRL-L or |
| 708 CTRL-P Search backwards for next matching line. This line | |
| 709 replaces the previous matching line. | |
| 710 | |
| 711 CTRL-N Search forward for next matching line. This line | |
| 712 replaces the previous matching line. | |
| 713 | |
| 714 CTRL-X CTRL-L After expanding a line you can additionally get the | |
| 715 line next to it by typing CTRL-X CTRL-L again, unless | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
716 a double CTRL-X is used. Only works for loaded |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
717 buffers. |
| 7 | 718 |
| 719 Completing keywords in current file *compl-current* | |
| 720 | |
| 721 *i_CTRL-X_CTRL-P* | |
| 722 *i_CTRL-X_CTRL-N* | |
| 723 CTRL-X CTRL-N Search forwards for words that start with the keyword | |
| 724 in front of the cursor. The found keyword is inserted | |
| 725 in front of the cursor. | |
| 726 | |
| 727 CTRL-X CTRL-P Search backwards for words that start with the keyword | |
| 728 in front of the cursor. The found keyword is inserted | |
| 729 in front of the cursor. | |
| 730 | |
| 731 CTRL-N Search forward for next matching keyword. This | |
| 732 keyword replaces the previous matching keyword. | |
| 733 | |
| 734 CTRL-P Search backwards for next matching keyword. This | |
| 735 keyword replaces the previous matching keyword. | |
| 736 | |
| 737 CTRL-X CTRL-N or | |
| 738 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will | |
| 739 copy the words following the previous expansion in | |
| 740 other contexts unless a double CTRL-X is used. | |
| 741 | |
| 742 If there is a keyword in front of the cursor (a name made out of alphabetic | |
| 743 characters and characters in 'iskeyword'), it is used as the search pattern, | |
| 744 with "\<" prepended (meaning: start of a word). Otherwise "\<\k\k" is used | |
| 745 as search pattern (start of any keyword of at least two characters). | |
| 746 | |
| 747 In Replace mode, the number of characters that are replaced depends on the | |
| 748 length of the matched string. This works like typing the characters of the | |
| 749 matched string in Replace mode. | |
| 750 | |
| 751 If there is not a valid keyword character before the cursor, any keyword of | |
| 752 at least two characters is matched. | |
| 753 e.g., to get: | |
| 754 printf("(%g, %g, %g)", vector[0], vector[1], vector[2]); | |
| 755 just type: | |
| 756 printf("(%g, %g, %g)", vector[0], ^P[1], ^P[2]); | |
| 757 | |
| 523 | 758 The search wraps around the end of the file, the value of 'wrapscan' is not |
| 759 used here. | |
| 760 | |
| 7 | 761 Multiple repeats of the same completion are skipped; thus a different match |
| 762 will be inserted at each CTRL-N and CTRL-P (unless there is only one | |
| 763 matching keyword). | |
| 764 | |
| 765 Single character matches are never included, as they usually just get in | |
| 766 the way of what you were really after. | |
| 767 e.g., to get: | |
| 768 printf("name = %s\n", name); | |
| 769 just type: | |
| 770 printf("name = %s\n", n^P); | |
| 771 or even: | |
| 772 printf("name = %s\n", ^P); | |
| 773 The 'n' in '\n' is skipped. | |
| 774 | |
| 775 After expanding a word, you can use CTRL-X CTRL-P or CTRL-X CTRL-N to get the | |
| 776 word following the expansion in other contexts. These sequences search for | |
| 777 the text just expanded and further expand by getting an extra word. This is | |
| 778 useful if you need to repeat a sequence of complicated words. Although CTRL-P | |
| 779 and CTRL-N look just for strings of at least two characters, CTRL-X CTRL-P and | |
| 780 CTRL-X CTRL-N can be used to expand words of just one character. | |
| 781 e.g., to get: | |
| 782 México | |
| 783 you can type: | |
| 784 M^N^P^X^P^X^P | |
| 785 CTRL-N starts the expansion and then CTRL-P takes back the single character | |
| 786 "M", the next two CTRL-X CTRL-P's get the words "é" and ";xico". | |
| 787 | |
| 788 If the previous expansion was split, because it got longer than 'textwidth', | |
| 789 then just the text in the current line will be used. | |
| 790 | |
| 791 If the match found is at the end of a line, then the first word in the next | |
| 792 line will be inserted and the message "word from next line" displayed, if | |
| 793 this word is accepted the next CTRL-X CTRL-P or CTRL-X CTRL-N will search | |
| 794 for those lines starting with this word. | |
| 795 | |
| 796 | |
| 797 Completing keywords in 'dictionary' *compl-dictionary* | |
| 798 | |
| 799 *i_CTRL-X_CTRL-K* | |
| 800 CTRL-X CTRL-K Search the files given with the 'dictionary' option | |
| 801 for words that start with the keyword in front of the | |
| 802 cursor. This is like CTRL-N, but only the dictionary | |
| 803 files are searched, not the current file. The found | |
| 804 keyword is inserted in front of the cursor. This | |
| 805 could potentially be pretty slow, since all matches | |
| 806 are found before the first match is used. By default, | |
| 807 the 'dictionary' option is empty. | |
| 808 For suggestions where to find a list of words, see the | |
| 809 'dictionary' option. | |
| 810 | |
| 811 CTRL-K or | |
| 812 CTRL-N Search forward for next matching keyword. This | |
| 813 keyword replaces the previous matching keyword. | |
| 814 | |
| 815 CTRL-P Search backwards for next matching keyword. This | |
| 816 keyword replaces the previous matching keyword. | |
| 817 | |
| 818 *i_CTRL-X_CTRL-T* | |
| 236 | 819 CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses |
| 7 | 820 the 'thesaurus' option instead of 'dictionary'. If a |
| 821 match is found in the thesaurus file, all the | |
| 822 remaining words on the same line are included as | |
| 823 matches, even though they don't complete the word. | |
| 824 Thus a word can be completely replaced. | |
| 825 | |
| 826 For an example, imagine the 'thesaurus' file has a | |
| 827 line like this: > | |
| 828 angry furious mad enraged | |
| 829 < Placing the cursor after the letters "ang" and typing | |
| 830 CTRL-X CTRL-T would complete the word "angry"; | |
| 831 subsequent presses would change the word to "furious", | |
| 832 "mad" etc. | |
| 833 Other uses include translation between two languages, | |
| 834 or grouping API functions by keyword. | |
| 835 | |
| 836 CTRL-T or | |
| 837 CTRL-N Search forward for next matching keyword. This | |
| 838 keyword replaces the previous matching keyword. | |
| 839 | |
| 840 CTRL-P Search backwards for next matching keyword. This | |
| 841 keyword replaces the previous matching keyword. | |
| 842 | |
| 843 | |
| 844 Completing keywords in the current and included files *compl-keyword* | |
| 845 | |
| 846 The 'include' option is used to specify a line that contains an include file | |
| 847 name. The 'path' option is used to search for include files. | |
| 848 | |
| 849 *i_CTRL-X_CTRL-I* | |
| 850 CTRL-X CTRL-I Search for the first keyword in the current and | |
| 851 included files that starts with the same characters | |
| 852 as those before the cursor. The matched keyword is | |
| 853 inserted in front of the cursor. | |
| 854 | |
| 855 CTRL-N Search forwards for next matching keyword. This | |
| 856 keyword replaces the previous matching keyword. | |
| 857 Note: CTRL-I is the same as <Tab>, which is likely to | |
| 858 be typed after a successful completion, therefore | |
| 859 CTRL-I is not used for searching for the next match. | |
| 860 | |
| 861 CTRL-P Search backward for previous matching keyword. This | |
| 862 keyword replaces the previous matching keyword. | |
| 863 | |
| 864 CTRL-X CTRL-I Further use of CTRL-X CTRL-I will copy the words | |
| 865 following the previous expansion in other contexts | |
| 866 unless a double CTRL-X is used. | |
| 867 | |
| 868 Completing tags *compl-tag* | |
| 869 *i_CTRL-X_CTRL-]* | |
| 870 CTRL-X CTRL-] Search for the first tag that starts with the same | |
| 871 characters as before the cursor. The matching tag is | |
| 872 inserted in front of the cursor. Alphabetic | |
| 873 characters and characters in 'iskeyword' are used | |
| 874 to decide which characters are included in the tag | |
| 875 name (same as for a keyword). See also |CTRL-]|. | |
| 876 The 'showfulltag' option can be used to add context | |
| 877 from around the tag definition. | |
| 878 CTRL-] or | |
| 879 CTRL-N Search forwards for next matching tag. This tag | |
| 880 replaces the previous matching tag. | |
| 881 | |
| 882 CTRL-P Search backward for previous matching tag. This tag | |
| 883 replaces the previous matching tag. | |
| 884 | |
| 885 | |
| 886 Completing file names *compl-filename* | |
| 887 *i_CTRL-X_CTRL-F* | |
| 888 CTRL-X CTRL-F Search for the first file name that starts with the | |
| 889 same characters as before the cursor. The matching | |
| 890 file name is inserted in front of the cursor. | |
| 891 Alphabetic characters and characters in 'isfname' | |
| 892 are used to decide which characters are included in | |
| 893 the file name. Note: the 'path' option is not used | |
| 894 here (yet). | |
| 895 CTRL-F or | |
| 896 CTRL-N Search forwards for next matching file name. This | |
| 897 file name replaces the previous matching file name. | |
| 898 | |
| 899 CTRL-P Search backward for previous matching file name. | |
| 900 This file name replaces the previous matching file | |
| 901 name. | |
| 902 | |
| 903 | |
| 904 Completing definitions or macros *compl-define* | |
| 905 | |
| 906 The 'define' option is used to specify a line that contains a definition. | |
| 907 The 'include' option is used to specify a line that contains an include file | |
| 908 name. The 'path' option is used to search for include files. | |
| 909 | |
| 910 *i_CTRL-X_CTRL-D* | |
| 911 CTRL-X CTRL-D Search in the current and included files for the | |
| 912 first definition (or macro) name that starts with | |
| 913 the same characters as before the cursor. The found | |
| 914 definition name is inserted in front of the cursor. | |
| 915 CTRL-D or | |
| 916 CTRL-N Search forwards for next matching macro name. This | |
| 917 macro name replaces the previous matching macro | |
| 918 name. | |
| 919 | |
| 920 CTRL-P Search backward for previous matching macro name. | |
| 921 This macro name replaces the previous matching macro | |
| 922 name. | |
| 923 | |
| 924 CTRL-X CTRL-D Further use of CTRL-X CTRL-D will copy the words | |
| 925 following the previous expansion in other contexts | |
| 926 unless a double CTRL-X is used. | |
| 927 | |
| 928 | |
| 929 Completing Vim commands *compl-vim* | |
| 930 | |
| 931 Completion is context-sensitive. It works like on the Command-line. It | |
| 449 | 932 completes an Ex command as well as its arguments. This is useful when writing |
| 933 a Vim script. | |
| 7 | 934 |
| 935 *i_CTRL-X_CTRL-V* | |
| 936 CTRL-X CTRL-V Guess what kind of item is in front of the cursor and | |
| 937 find the first match for it. | |
| 938 Note: When CTRL-V is mapped you can often use CTRL-Q | |
| 1620 | 939 instead of |i_CTRL-Q|. |
| 7 | 940 CTRL-V or |
| 941 CTRL-N Search forwards for next match. This match replaces | |
| 942 the previous one. | |
| 943 | |
| 1620 | 944 CTRL-P Search backwards for previous match. This match |
| 7 | 945 replaces the previous one. |
| 946 | |
| 947 CTRL-X CTRL-V Further use of CTRL-X CTRL-V will do the same as | |
| 948 CTRL-V. This allows mapping a key to do Vim command | |
| 949 completion, for example: > | |
| 950 :imap <Tab> <C-X><C-V> | |
| 951 | |
| 449 | 952 User defined completion *compl-function* |
| 12 | 953 |
| 954 Completion is done by a function that can be defined by the user with the | |
| 648 | 955 'completefunc' option. See below for how the function is called and an |
| 956 example |complete-functions|. | |
| 12 | 957 |
| 958 *i_CTRL-X_CTRL-U* | |
| 959 CTRL-X CTRL-U Guess what kind of item is in front of the cursor and | |
| 960 find the first match for it. | |
| 961 CTRL-U or | |
| 962 CTRL-N Use the next match. This match replaces the previous | |
| 963 one. | |
| 964 | |
| 965 CTRL-P Use the previous match. This match replaces the | |
| 966 previous one. | |
| 967 | |
| 968 | |
| 523 | 969 Omni completion *compl-omni* |
| 449 | 970 |
| 502 | 971 Completion is done by a function that can be defined by the user with the |
| 523 | 972 'omnifunc' option. This is to be used for filetype-specific completion. |
| 502 | 973 |
| 648 | 974 See below for how the function is called and an example |complete-functions|. |
| 523 | 975 For remarks about specific filetypes see |compl-omni-filetypes|. |
| 859 | 976 More completion scripts will appear, check www.vim.org. Currently there is a |
| 977 first version for C++. | |
| 449 | 978 |
| 979 *i_CTRL-X_CTRL-O* | |
| 980 CTRL-X CTRL-O Guess what kind of item is in front of the cursor and | |
| 981 find the first match for it. | |
| 982 CTRL-O or | |
| 983 CTRL-N Use the next match. This match replaces the previous | |
| 984 one. | |
| 985 | |
| 986 CTRL-P Use the previous match. This match replaces the | |
| 987 previous one. | |
| 988 | |
| 989 | |
| 477 | 990 Spelling suggestions *compl-spelling* |
| 991 | |
| 483 | 992 A word before or at the cursor is located and correctly spelled words are |
| 993 suggested to replace it. If there is a badly spelled word in the line, before | |
| 994 or under the cursor, the cursor is moved to after it. Otherwise the word just | |
| 995 before the cursor is used for suggestions, even though it isn't badly spelled. | |
| 996 | |
| 477 | 997 NOTE: CTRL-S suspends display in many Unix terminals. Use 's' instead. Type |
| 998 CTRL-Q to resume displaying. | |
| 999 | |
| 1000 *i_CTRL-X_CTRL-S* *i_CTRL-X_s* | |
| 1001 CTRL-X CTRL-S or | |
| 1002 CTRL-X s Locate the word in front of the cursor and find the | |
| 1003 first spell suggestion for it. | |
| 1004 CTRL-S or | |
| 1005 CTRL-N Use the next suggestion. This replaces the previous | |
| 1006 one. Note that you can't use 's' here. | |
| 1007 | |
| 1008 CTRL-P Use the previous suggestion. This replaces the | |
| 1009 previous one. | |
| 1010 | |
| 1011 | |
| 7 | 1012 Completing keywords from different sources *compl-generic* |
| 1013 | |
| 1014 *i_CTRL-N* | |
| 1015 CTRL-N Find next match for words that start with the | |
| 1016 keyword in front of the cursor, looking in places | |
| 1017 specified with the 'complete' option. The found | |
| 1018 keyword is inserted in front of the cursor. | |
| 1019 | |
| 1020 *i_CTRL-P* | |
| 1021 CTRL-P Find previous match for words that start with the | |
| 1022 keyword in front of the cursor, looking in places | |
| 1023 specified with the 'complete' option. The found | |
| 1024 keyword is inserted in front of the cursor. | |
| 1025 | |
| 1026 CTRL-N Search forward for next matching keyword. This | |
| 1027 keyword replaces the previous matching keyword. | |
| 1028 | |
| 1029 CTRL-P Search backwards for next matching keyword. This | |
| 1030 keyword replaces the previous matching keyword. | |
| 1031 | |
| 1032 CTRL-X CTRL-N or | |
| 1033 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will | |
| 1034 copy the words following the previous expansion in | |
| 1035 other contexts unless a double CTRL-X is used. | |
| 1036 | |
| 519 | 1037 |
| 648 | 1038 FUNCTIONS FOR FINDING COMPLETIONS *complete-functions* |
| 1039 | |
| 1040 This applies to 'completefunc' and 'omnifunc'. | |
| 1041 | |
| 659 | 1042 The function is called in two different ways: |
| 1043 - First the function is called to find the start of the text to be completed. | |
| 1044 - Later the function is called to actually find the matches. | |
| 648 | 1045 |
| 1046 On the first invocation the arguments are: | |
| 1047 a:findstart 1 | |
| 1048 a:base empty | |
| 1049 | |
| 659 | 1050 The function must return the column where the completion starts. It must be a |
| 1051 number between zero and the cursor column "col('.')". This involves looking | |
| 1052 at the characters just before the cursor and including those characters that | |
| 1053 could be part of the completed item. The text between this column and the | |
| 14637 | 1054 cursor column will be replaced with the matches. If the returned value is |
| 1055 larger than the cursor column, the cursor column is used. | |
|
3526
dd6c2497c997
Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
1056 |
| 14637 | 1057 Negative return values: |
| 1058 -2 To cancel silently and stay in completion mode. | |
| 1059 -3 To cancel silently and leave completion mode. | |
| 1060 Another negative value: completion starts at the cursor column | |
| 648 | 1061 |
| 1062 On the second invocation the arguments are: | |
| 1063 a:findstart 0 | |
| 659 | 1064 a:base the text with which matches should match; the text that was |
| 648 | 1065 located in the first call (can be empty) |
| 1066 | |
| 1067 The function must return a List with the matching words. These matches | |
| 1068 usually include the "a:base" text. When there are no matches return an empty | |
| 659 | 1069 List. |
| 3082 | 1070 |
| 1071 In order to return more information than the matching words, return a Dict | |
| 1072 that contains the List. The Dict can have these items: | |
| 1073 words The List of matching words (mandatory). | |
| 1074 refresh A string to control re-invocation of the function | |
| 1075 (optional). | |
| 1076 The only value currently recognized is "always", the | |
| 1077 effect is that the function is called whenever the | |
| 1078 leading text is changed. | |
|
15416
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1079 |
|
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1080 If you want to suppress the warning message for an empty result, return |
|
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1081 v:none. This is useful to implement asynchronous completion with complete(). |
|
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1082 |
| 3082 | 1083 Other items are ignored. |
| 1084 | |
| 3682 | 1085 For acting upon end of completion, see the |CompleteDone| autocommand event. |
| 1086 | |
| 3082 | 1087 For example, the function can contain this: > |
| 1088 let matches = ... list of words ... | |
| 1089 return {'words': matches, 'refresh': 'always'} | |
| 1090 < | |
| 723 | 1091 *complete-items* |
| 659 | 1092 Each list item can either be a string or a Dictionary. When it is a string it |
| 1093 is used as the completion. When it is a Dictionary it can contain these | |
| 1094 items: | |
| 819 | 1095 word the text that will be inserted, mandatory |
| 1096 abbr abbreviation of "word"; when not empty it is used in | |
| 1097 the menu instead of "word" | |
| 820 | 1098 menu extra text for the popup menu, displayed after "word" |
| 1099 or "abbr" | |
| 819 | 1100 info more information about the item, can be displayed in a |
| 1101 preview window | |
| 659 | 1102 kind single letter indicating the type of completion |
| 867 | 1103 icase when non-zero case is to be ignored when comparing |
| 1104 items to be equal; when omitted zero is used, thus | |
| 1105 items that only differ in case are added | |
| 841 | 1106 dup when non-zero this match will be added even when an |
| 1107 item with the same word is already present. | |
| 2642 | 1108 empty when non-zero this match will be added even when it is |
| 1109 an empty string | |
|
13238
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1110 user_data custom data which is associated with the item and |
|
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1111 available in |v:completed_item| |
| 659 | 1112 |
| 11062 | 1113 All of these except "icase", "dup" and "empty" must be a string. If an item |
| 3082 | 1114 does not meet these requirements then an error message is given and further |
| 1115 items in the list are not used. You can mix string and Dictionary items in | |
| 1116 the returned list. | |
| 659 | 1117 |
| 1118 The "menu" item is used in the popup menu and may be truncated, thus it should | |
| 728 | 1119 be relatively short. The "info" item can be longer, it will be displayed in |
| 1120 the preview window when "preview" appears in 'completeopt'. The "info" item | |
| 1121 will also remain displayed after the popup menu has been removed. This is | |
| 838 | 1122 useful for function arguments. Use a single space for "info" to remove |
| 2625 | 1123 existing text in the preview window. The size of the preview window is three |
| 1124 lines, but 'previewheight' is used when it has a value of 1 or 2. | |
| 659 | 1125 |
| 1126 The "kind" item uses a single letter to indicate the kind of completion. This | |
| 1127 may be used to show the completion differently (different color or icon). | |
| 1128 Currently these types can be used: | |
| 1129 v variable | |
| 1130 f function or method | |
| 728 | 1131 m member of a struct or class |
| 1132 t typedef | |
| 1133 d #define or macro | |
| 648 | 1134 |
| 1135 When searching for matches takes some time call |complete_add()| to add each | |
| 1136 match to the total list. These matches should then not appear in the returned | |
| 1137 list! Call |complete_check()| now and then to allow the user to press a key | |
| 1138 while still searching for matches. Stop searching when it returns non-zero. | |
| 1139 | |
| 2642 | 1140 *E839* *E840* |
| 1141 The function is allowed to move the cursor, it is restored afterwards. | |
| 1142 The function is not allowed to move to another window or delete text. | |
| 648 | 1143 |
| 1144 An example that completes the names of the months: > | |
| 1145 fun! CompleteMonths(findstart, base) | |
| 1146 if a:findstart | |
| 1147 " locate the start of the word | |
| 1148 let line = getline('.') | |
| 1149 let start = col('.') - 1 | |
| 1150 while start > 0 && line[start - 1] =~ '\a' | |
| 1151 let start -= 1 | |
| 1152 endwhile | |
| 1153 return start | |
| 1154 else | |
| 1155 " find months matching with "a:base" | |
| 1156 let res = [] | |
| 1157 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") | |
| 1158 if m =~ '^' . a:base | |
| 1159 call add(res, m) | |
| 1160 endif | |
| 1161 endfor | |
| 1162 return res | |
| 1163 endif | |
| 1164 endfun | |
| 1165 set completefunc=CompleteMonths | |
| 1166 < | |
| 1167 The same, but now pretending searching for matches is slow: > | |
| 1168 fun! CompleteMonths(findstart, base) | |
| 1169 if a:findstart | |
| 1170 " locate the start of the word | |
| 1171 let line = getline('.') | |
| 1172 let start = col('.') - 1 | |
| 1173 while start > 0 && line[start - 1] =~ '\a' | |
| 1174 let start -= 1 | |
| 1175 endwhile | |
| 1176 return start | |
| 1177 else | |
| 1178 " find months matching with "a:base" | |
| 1179 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") | |
| 1180 if m =~ '^' . a:base | |
| 1181 call complete_add(m) | |
| 1182 endif | |
| 1183 sleep 300m " simulate searching for next match | |
| 1184 if complete_check() | |
| 1185 break | |
| 1186 endif | |
| 1187 endfor | |
| 1188 return [] | |
| 1189 endif | |
| 1190 endfun | |
| 1191 set completefunc=CompleteMonths | |
| 1192 < | |
| 1193 | |
| 540 | 1194 INSERT COMPLETION POPUP MENU *ins-completion-menu* |
| 620 | 1195 *popupmenu-completion* |
| 540 | 1196 Vim can display the matches in a simplistic popup menu. |
| 1197 | |
| 1198 The menu is used when: | |
| 715 | 1199 - The 'completeopt' option contains "menu" or "menuone". |
| 540 | 1200 - The terminal supports at least 8 colors. |
| 857 | 1201 - There are at least two matches. One if "menuone" is used. |
| 540 | 1202 |
| 765 | 1203 The 'pumheight' option can be used to set a maximum height. The default is to |
| 1204 use all space available. | |
|
13238
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1205 The 'pumwidth' option can be used to set a minimum width. The default is 15 |
|
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1206 characters. |
| 765 | 1207 |
| 825 | 1208 There are three states: |
| 1209 1. A complete match has been inserted, e.g., after using CTRL-N or CTRL-P. | |
| 1210 2. A cursor key has been used to select another match. The match was not | |
| 1211 inserted then, only the entry in the popup menu is highlighted. | |
| 1212 3. Only part of a match has been inserted and characters were typed or the | |
| 1213 backspace key was used. The list of matches was then adjusted for what is | |
| 1214 in front of the cursor. | |
| 667 | 1215 |
| 682 | 1216 You normally start in the first state, with the first match being inserted. |
| 667 | 1217 When "longest" is in 'completeopt' and there is more than one match you start |
| 825 | 1218 in the third state. |
| 665 | 1219 |
| 825 | 1220 If you select another match, e.g., with CTRL-N or CTRL-P, you go to the first |
| 1221 state. This doesn't change the list of matches. | |
| 682 | 1222 |
| 825 | 1223 When you are back at the original text then you are in the third state. To |
| 715 | 1224 get there right away you can use a mapping that uses CTRL-P right after |
| 1225 starting the completion: > | |
| 1226 :imap <F7> <C-N><C-P> | |
| 793 | 1227 < |
| 1228 *popupmenu-keys* | |
| 667 | 1229 In the first state these keys have a special meaning: |
| 1230 <BS> and CTRL-H Delete one character, find the matches for the word before | |
| 1231 the cursor. This reduces the list of matches, often to one | |
| 682 | 1232 entry, and switches to the second state. |
| 825 | 1233 Any non-special character: |
| 1234 Stop completion without changing the match and insert the | |
| 1235 typed character. | |
| 665 | 1236 |
| 825 | 1237 In the second and third state these keys have a special meaning: |
| 659 | 1238 <BS> and CTRL-H Delete one character, find the matches for the shorter word |
| 1239 before the cursor. This may find more matches. | |
| 1240 CTRL-L Add one character from the current match, may reduce the | |
| 667 | 1241 number of matches. |
| 682 | 1242 any printable, non-white character: |
| 1243 Add this character and reduce the number of matches. | |
| 667 | 1244 |
| 825 | 1245 In all three states these can be used: |
| 816 | 1246 CTRL-Y Yes: Accept the currently selected match and stop completion. |
| 1121 | 1247 CTRL-E End completion, go back to what was there before selecting a |
| 1248 match (what was typed or longest common string). | |
| 682 | 1249 <PageUp> Select a match several entries back, but don't insert it. |
| 1250 <PageDown> Select a match several entries further, but don't insert it. | |
| 665 | 1251 <Up> Select the previous match, as if CTRL-P was used, but don't |
| 682 | 1252 insert it. |
| 665 | 1253 <Down> Select the next match, as if CTRL-N was used, but don't |
| 682 | 1254 insert it. |
| 1121 | 1255 <Space> or <Tab> Stop completion without changing the match and insert the |
| 825 | 1256 typed character. |
| 1257 | |
| 1203 | 1258 The behavior of the <Enter> key depends on the state you are in: |
| 825 | 1259 first state: Use the text as it is and insert a line break. |
| 1260 second state: Insert the currently selected match. | |
| 1261 third state: Use the text as it is and insert a line break. | |
| 1262 | |
| 1263 In other words: If you used the cursor keys to select another entry in the | |
| 1203 | 1264 list of matches then the <Enter> key inserts that match. If you typed |
| 1265 something else then <Enter> inserts a line break. | |
| 667 | 1266 |
| 540 | 1267 |
| 1268 The colors of the menu can be changed with these highlight groups: | |
| 1269 Pmenu normal item |hl-Pmenu| | |
| 1270 PmenuSel selected item |hl-PmenuSel| | |
| 1271 PmenuSbar scrollbar |hl-PmenuSbar| | |
| 1272 PmenuThumb thumb of the scrollbar |hl-PmenuThumb| | |
| 1273 | |
| 667 | 1274 There are no special mappings for when the popup menu is visible. However, |
| 1275 you can use an Insert mode mapping that checks the |pumvisible()| function to | |
| 1276 do something different. Example: > | |
| 1277 :inoremap <Down> <C-R>=pumvisible() ? "\<lt>C-N>" : "\<lt>Down>"<CR> | |
| 540 | 1278 |
| 723 | 1279 You can use of <expr> in mapping to have the popup menu used when typing a |
| 1280 character and some condition is met. For example, for typing a dot: > | |
| 1281 inoremap <expr> . MayComplete() | |
| 1282 func MayComplete() | |
| 1283 if (can complete) | |
| 1284 return ".\<C-X>\<C-O>" | |
| 1285 endif | |
| 1286 return '.' | |
| 1287 endfunc | |
| 1288 | |
| 1289 See |:map-<expr>| for more info. | |
| 1290 | |
| 667 | 1291 |
| 1292 FILETYPE-SPECIFIC REMARKS FOR OMNI COMPLETION *compl-omni-filetypes* | |
| 1293 | |
| 1294 The file used for {filetype} should be autoload/{filetype}complete.vim | |
| 1295 in 'runtimepath'. Thus for "java" it is autoload/javacomplete.vim. | |
| 519 | 1296 |
| 557 | 1297 |
| 523 | 1298 C *ft-c-omni* |
| 519 | 1299 |
| 523 | 1300 Completion of C code requires a tags file. You should use Exuberant ctags, |
| 1301 because it adds extra information that is needed for completion. You can find | |
| 1121 | 1302 it here: http://ctags.sourceforge.net/ Version 5.6 or later is recommended. |
| 1303 | |
| 523 | 1304 For version 5.5.4 you should add a patch that adds the "typename:" field: |
| 711 | 1305 ftp://ftp.vim.org/pub/vim/unstable/patches/ctags-5.5.4.patch |
| 659 | 1306 A compiled .exe for MS-Windows can be found at: |
| 12968 | 1307 http://ctags.sourceforge.net/ |
| 1308 https://github.com/universal-ctags/ctags-win32 | |
| 519 | 1309 |
| 1310 If you want to complete system functions you can do something like this. Use | |
| 1311 ctags to generate a tags file for all the system header files: > | |
| 1312 % ctags -R -f ~/.vim/systags /usr/include /usr/local/include | |
| 1313 In your vimrc file add this tags file to the 'tags' option: > | |
| 1314 set tags+=~/.vim/systags | |
| 1315 | |
| 1316 When using CTRL-X CTRL-O after a name without any "." or "->" it is completed | |
| 1317 from the tags file directly. This works for any identifier, also function | |
| 1318 names. If you want to complete a local variable name, which does not appear | |
| 1319 in the tags file, use CTRL-P instead. | |
| 1320 | |
| 1321 When using CTRL-X CTRL-O after something that has "." or "->" Vim will attempt | |
| 1322 to recognize the type of the variable and figure out what members it has. | |
| 1323 This means only members valid for the variable will be listed. | |
| 1324 | |
| 523 | 1325 When a member name already was complete, CTRL-X CTRL-O will add a "." or |
| 1326 "->" for composite types. | |
| 1327 | |
| 519 | 1328 Vim doesn't include a C compiler, only the most obviously formatted |
| 1329 declarations are recognized. Preprocessor stuff may cause confusion. | |
| 1330 When the same structure name appears in multiple places all possible members | |
| 1331 are included. | |
| 1332 | |
| 529 | 1333 |
| 625 | 1334 CSS *ft-css-omni* |
| 557 | 1335 |
| 1336 Complete properties and their appropriate values according to CSS 2.1 | |
| 818 | 1337 specification. |
| 557 | 1338 |
| 1339 | |
| 818 | 1340 HTML *ft-html-omni* |
| 1341 XHTML *ft-xhtml-omni* | |
| 529 | 1342 |
| 667 | 1343 CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is |
| 6051 | 1344 designed to support writing of XHTML 1.0 Strict files but will also work for |
| 667 | 1345 other versions of HTML. Features: |
| 529 | 1346 |
| 667 | 1347 - after "<" complete tag name depending on context (no div suggestion inside |
| 1348 of an a tag); '/>' indicates empty tags | |
| 1349 - inside of tag complete proper attributes (no width attribute for an a tag); | |
| 1350 show also type of attribute; '*' indicates required attributes | |
| 1351 - when attribute has limited number of possible values help to complete them | |
| 557 | 1352 - complete names of entities |
| 532 | 1353 - complete values of "class" and "id" attributes with data obtained from |
| 667 | 1354 <style> tag and included CSS files |
| 659 | 1355 - when completing value of "style" attribute or working inside of "style" tag |
| 532 | 1356 switch to |ft-css-omni| completion |
| 667 | 1357 - when completing values of events attributes or working inside of "script" |
| 1358 tag switch to |ft-javascript-omni| completion | |
| 532 | 1359 - when used after "</" CTRL-X CTRL-O will close the last opened tag |
| 529 | 1360 |
| 557 | 1361 Note: When used first time completion menu will be shown with little delay |
| 818 | 1362 - this is time needed for loading of data file. |
| 659 | 1363 Note: Completion may fail in badly formatted documents. In such case try to |
| 1364 run |:make| command to detect formatting problems. | |
| 557 | 1365 |
| 1366 | |
| 836 | 1367 HTML flavor *html-flavor* |
| 1368 | |
| 859 | 1369 The default HTML completion depends on the filetype. For HTML files it is |
| 1370 HTML 4.01 Transitional ('filetype' is "html"), for XHTML it is XHTML 1.0 | |
| 1371 Strict ('filetype' is "xhtml"). | |
| 836 | 1372 |
| 859 | 1373 When doing completion outside of any other tag you will have possibility to |
| 1374 choose DOCTYPE and the appropriate data file will be loaded and used for all | |
| 1375 next completions. | |
| 836 | 1376 |
| 859 | 1377 More about format of data file in |xml-omni-datafile|. Some of the data files |
| 1378 may be found on the Vim website (|www|). | |
| 836 | 1379 |
| 859 | 1380 Note that b:html_omni_flavor may point to a file with any XML data. This |
| 1381 makes possible to mix PHP (|ft-php-omni|) completion with any XML dialect | |
| 1382 (assuming you have data file for it). Without setting that variable XHTML 1.0 | |
| 1383 Strict will be used. | |
| 836 | 1384 |
| 1385 | |
| 818 | 1386 JAVASCRIPT *ft-javascript-omni* |
| 649 | 1387 |
| 659 | 1388 Completion of most elements of JavaScript language and DOM elements. |
| 649 | 1389 |
| 1390 Complete: | |
| 1391 | |
| 1392 - variables | |
| 667 | 1393 - function name; show function arguments |
| 649 | 1394 - function arguments |
| 1395 - properties of variables trying to detect type of variable | |
| 659 | 1396 - complete DOM objects and properties depending on context |
| 649 | 1397 - keywords of language |
| 1398 | |
| 659 | 1399 Completion works in separate JavaScript files (&ft==javascript), inside of |
| 1400 <script> tag of (X)HTML and in values of event attributes (including scanning | |
| 5220 | 1401 of external files). |
| 818 | 1402 |
| 649 | 1403 DOM compatibility |
| 1404 | |
| 1405 At the moment (beginning of 2006) there are two main browsers - MS Internet | |
| 1406 Explorer and Mozilla Firefox. These two applications are covering over 90% of | |
| 1407 market. Theoretically standards are created by W3C organisation | |
| 1408 (http://www.w3c.org) but they are not always followed/implemented. | |
| 1409 | |
| 818 | 1410 IE FF W3C Omni completion ~ |
| 1411 +/- +/- + + ~ | |
| 1412 + + - + ~ | |
| 1413 + - - - ~ | |
| 1414 - + - - ~ | |
| 649 | 1415 |
| 1416 Regardless from state of implementation in browsers but if element is defined | |
| 1417 in standards, completion plugin will place element in suggestion list. When | |
| 1418 both major engines implemented element, even if this is not in standards it | |
| 1419 will be suggested. All other elements are not placed in suggestion list. | |
| 1420 | |
| 1421 | |
| 818 | 1422 PHP *ft-php-omni* |
| 714 | 1423 |
| 1121 | 1424 Completion of PHP code requires a tags file for completion of data from |
| 1425 external files and for class aware completion. You should use Exuberant ctags | |
| 1426 version 5.5.4 or newer. You can find it here: http://ctags.sourceforge.net/ | |
| 714 | 1427 |
| 1428 Script completes: | |
| 1429 | |
| 1430 - after $ variables name | |
| 728 | 1431 - if variable was declared as object add "->", if tags file is available show |
| 1432 name of class | |
| 819 | 1433 - after "->" complete only function and variable names specific for given |
| 1434 class. To find class location and contents tags file is required. Because | |
| 1435 PHP isn't strongly typed language user can use @var tag to declare class: > | |
| 1436 | |
| 856 | 1437 /* @var $myVar myClass */ |
| 819 | 1438 $myVar-> |
| 1439 < | |
| 1440 Still, to find myClass contents tags file is required. | |
| 728 | 1441 |
| 843 | 1442 - function names with additional info: |
| 728 | 1443 - in case of built-in functions list of possible arguments and after | type |
| 1444 data returned by function | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1445 - in case of user function arguments and name of file where function was |
| 728 | 1446 defined (if it is not current file) |
| 1447 | |
| 1448 - constants names | |
| 1449 - class names after "new" declaration | |
| 1450 | |
| 714 | 1451 |
| 1452 Note: when doing completion first time Vim will load all necessary data into | |
| 1453 memory. It may take several seconds. After next use of completion delay | |
| 728 | 1454 should not be noticeable. |
| 714 | 1455 |
| 1456 Script detects if cursor is inside <?php ?> tags. If it is outside it will | |
| 1457 automatically switch to HTML/CSS/JavaScript completion. Note: contrary to | |
| 1458 original HTML files completion of tags (and only tags) isn't context aware. | |
| 1459 | |
| 1460 | |
| 856 | 1461 RUBY *ft-ruby-omni* |
| 838 | 1462 |
| 1463 Completion of Ruby code requires that vim be built with |+ruby|. | |
| 1464 | |
| 1465 Ruby completion will parse your buffer on demand in order to provide a list of | |
| 1466 completions. These completions will be drawn from modules loaded by 'require' | |
| 1467 and modules defined in the current buffer. | |
| 1468 | |
| 1469 The completions provided by CTRL-X CTRL-O are sensitive to the context: | |
| 1470 | |
| 856 | 1471 CONTEXT COMPLETIONS PROVIDED ~ |
| 838 | 1472 |
| 1473 1. Not inside a class definition Classes, constants and globals | |
| 1474 | |
| 856 | 1475 2. Inside a class definition Methods or constants defined in the class |
| 838 | 1476 |
| 856 | 1477 3. After '.', '::' or ':' Methods applicable to the object being |
| 1478 dereferenced | |
| 838 | 1479 |
| 856 | 1480 4. After ':' or ':foo' Symbol name (beginning with 'foo') |
| 838 | 1481 |
| 1482 Notes: | |
| 1483 - Vim will load/evaluate code in order to provide completions. This may | |
| 13125 | 1484 cause some code execution, which may be a concern. This is no longer |
| 1121 | 1485 enabled by default, to enable this feature add > |
| 1486 let g:rubycomplete_buffer_loading = 1 | |
| 1487 <- In context 1 above, Vim can parse the entire buffer to add a list of | |
| 843 | 1488 classes to the completion results. This feature is turned off by default, |
| 1489 to enable it add > | |
| 1490 let g:rubycomplete_classes_in_global = 1 | |
| 1491 < to your vimrc | |
| 838 | 1492 - In context 2 above, anonymous classes are not supported. |
| 1493 - In context 3 above, Vim will attempt to determine the methods supported by | |
| 1494 the object. | |
| 1495 - Vim can detect and load the Rails environment for files within a rails | |
| 1496 project. The feature is disabled by default, to enable it add > | |
| 843 | 1497 let g:rubycomplete_rails = 1 |
| 1498 < to your vimrc | |
| 838 | 1499 |
| 1500 | |
| 625 | 1501 SYNTAX *ft-syntax-omni* |
| 1502 | |
| 1121 | 1503 Vim has the ability to color syntax highlight nearly 500 languages. Part of |
| 1504 this highlighting includes knowing what keywords are part of a language. Many | |
| 1505 filetypes already have custom completion scripts written for them, the | |
| 1506 syntaxcomplete plugin provides basic completion for all other filetypes. It | |
| 1507 does this by populating the omni completion list with the text Vim already | |
| 1508 knows how to color highlight. It can be used for any filetype and provides a | |
| 1509 minimal language-sensitive completion. | |
| 625 | 1510 |
| 702 | 1511 To enable syntax code completion you can run: > |
| 4869 | 1512 setlocal omnifunc=syntaxcomplete#Complete |
| 702 | 1513 |
| 4869 | 1514 You can automate this by placing the following in your |.vimrc| (after any |
| 702 | 1515 ":filetype" command): > |
| 1516 if has("autocmd") && exists("+omnifunc") | |
| 818 | 1517 autocmd Filetype * |
| 1518 \ if &omnifunc == "" | | |
| 1519 \ setlocal omnifunc=syntaxcomplete#Complete | | |
| 1520 \ endif | |
| 702 | 1521 endif |
| 1522 | |
| 1523 The above will set completion to this script only if a specific plugin does | |
| 1524 not already exist for that filetype. | |
| 1525 | |
| 1526 Each filetype can have a wide range of syntax items. The plugin allows you to | |
| 1527 customize which syntax groups to include or exclude from the list. Let's have | |
| 1528 a look at the PHP filetype to see how this works. | |
| 1529 | |
| 1530 If you edit a file called, index.php, run the following command: > | |
| 4869 | 1531 syntax list |
| 625 | 1532 |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1533 The first thing you will notice is that there are many different syntax groups. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1534 The PHP language can include elements from different languages like HTML, |
| 702 | 1535 JavaScript and many more. The syntax plugin will only include syntax groups |
| 1536 that begin with the filetype, "php", in this case. For example these syntax | |
| 1537 groups are included by default with the PHP: phpEnvVar, phpIntVar, | |
| 1538 phpFunctions. | |
| 1539 | |
| 13125 | 1540 If you wish non-filetype syntax items to also be included, you can use a |
| 1541 regular expression syntax (added in version 13.0 of | |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
1542 autoload/syntaxcomplete.vim) to add items. Looking at the output from |
| 13125 | 1543 ":syntax list" while editing a PHP file I can see some of these entries: > |
| 4869 | 1544 htmlArg,htmlTag,htmlTagName,javaScriptStatement,javaScriptGlobalObjects |
| 625 | 1545 |
| 4869 | 1546 To pick up any JavaScript and HTML keyword syntax groups while editing a PHP |
| 13125 | 1547 file, you can use 3 different regexs, one for each language. Or you can |
| 1548 simply restrict the include groups to a particular value, without using | |
| 4869 | 1549 a regex string: > |
| 1550 let g:omni_syntax_group_include_php = 'php\w\+,javaScript\w\+,html\w\+' | |
| 1551 let g:omni_syntax_group_include_php = 'phpFunctions,phpMethods' | |
| 1552 < | |
| 1553 The basic form of this variable is: > | |
| 1554 let g:omni_syntax_group_include_{filetype} = 'regex,comma,separated' | |
| 1555 | |
| 1556 The PHP language has an enormous number of items which it knows how to syntax | |
| 5220 | 1557 highlight. These items will be available within the omni completion list. |
| 4869 | 1558 |
| 1559 Some people may find this list unwieldy or are only interested in certain | |
| 1560 items. There are two ways to prune this list (if necessary). If you find | |
| 13125 | 1561 certain syntax groups you do not wish displayed you can use two different |
| 1562 methods to identify these groups. The first specifically lists the syntax | |
| 1563 groups by name. The second uses a regular expression to identify both | |
| 4869 | 1564 syntax groups. Simply add one the following to your vimrc: > |
| 1565 let g:omni_syntax_group_exclude_php = 'phpCoreConstant,phpConstant' | |
| 1566 let g:omni_syntax_group_exclude_php = 'php\w*Constant' | |
| 702 | 1567 |
| 1568 Add as many syntax groups to this list by comma separating them. The basic | |
| 1569 form of this variable is: > | |
| 4869 | 1570 let g:omni_syntax_group_exclude_{filetype} = 'regex,comma,separated' |
| 702 | 1571 |
| 1572 You can create as many of these variables as you need, varying only the | |
| 1573 filetype at the end of the variable name. | |
| 625 | 1574 |
| 1121 | 1575 The plugin uses the isKeyword option to determine where word boundaries are |
| 1576 for the syntax items. For example, in the Scheme language completion should | |
| 1577 include the "-", call-with-output-file. Depending on your filetype, this may | |
| 1578 not provide the words you are expecting. Setting the | |
| 1579 g:omni_syntax_use_iskeyword option to 0 will force the syntax plugin to break | |
| 1580 on word characters. This can be controlled adding the following to your | |
| 1581 vimrc: > | |
| 1582 let g:omni_syntax_use_iskeyword = 0 | |
| 1583 | |
| 2439 | 1584 For plugin developers, the plugin exposes a public function OmniSyntaxList. |
| 1585 This function can be used to request a List of syntax items. When editing a | |
| 13125 | 1586 SQL file (:e syntax.sql) you can use the ":syntax list" command to see the |
| 2439 | 1587 various groups and syntax items. For example: > |
| 13125 | 1588 syntax list |
| 2439 | 1589 |
| 13125 | 1590 Yields data similar to this: |
| 1591 sqlOperator xxx some prior all like and any escape exists in is not ~ | |
| 1592 or intersect minus between distinct ~ | |
| 1593 links to Operator ~ | |
| 1594 sqlType xxx varbit varchar nvarchar bigint int uniqueidentifier ~ | |
| 1595 date money long tinyint unsigned xml text smalldate ~ | |
| 1596 double datetime nchar smallint numeric time bit char ~ | |
| 1597 varbinary binary smallmoney ~ | |
| 1598 image float integer timestamp real decimal ~ | |
| 2439 | 1599 |
| 1600 There are two syntax groups listed here: sqlOperator and sqlType. To retrieve | |
| 13125 | 1601 a List of syntax items you can call OmniSyntaxList a number of different |
| 2439 | 1602 ways. To retrieve all syntax items regardless of syntax group: > |
| 1603 echo OmniSyntaxList( [] ) | |
| 1604 | |
| 1605 To retrieve only the syntax items for the sqlOperator syntax group: > | |
| 1606 echo OmniSyntaxList( ['sqlOperator'] ) | |
| 1607 | |
| 1608 To retrieve all syntax items for both the sqlOperator and sqlType groups: > | |
| 1609 echo OmniSyntaxList( ['sqlOperator', 'sqlType'] ) | |
| 1610 | |
| 4869 | 1611 A regular expression can also be used: > |
| 1612 echo OmniSyntaxList( ['sql\w\+'] ) | |
| 1613 | |
| 2439 | 1614 From within a plugin, you would typically assign the output to a List: > |
| 1615 let myKeywords = [] | |
| 1616 let myKeywords = OmniSyntaxList( ['sqlKeyword'] ) | |
| 1617 | |
| 625 | 1618 |
| 818 | 1619 SQL *ft-sql-omni* |
| 1620 | |
| 1621 Completion for the SQL language includes statements, functions, keywords. | |
| 1622 It will also dynamically complete tables, procedures, views and column lists | |
| 1623 with data pulled directly from within a database. For detailed instructions | |
| 1624 and a tutorial see |omni-sql-completion|. | |
| 1625 | |
| 819 | 1626 The SQL completion plugin can be used in conjunction with other completion |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1627 plugins. For example, the PHP filetype has its own completion plugin. |
| 819 | 1628 Since PHP is often used to generate dynamic website by accessing a database, |
| 1629 the SQL completion plugin can also be enabled. This allows you to complete | |
| 1630 PHP code and SQL code at the same time. | |
| 1631 | |
| 818 | 1632 |
| 625 | 1633 XML *ft-xml-omni* |
| 557 | 1634 |
| 859 | 1635 Vim 7 provides a mechanism for context aware completion of XML files. It |
| 1636 depends on a special |xml-omni-datafile| and two commands: |:XMLns| and | |
| 1637 |:XMLent|. Features are: | |
| 557 | 1638 |
| 859 | 1639 - after "<" complete the tag name, depending on context |
| 1640 - inside of a tag complete proper attributes | |
| 1641 - when an attribute has a limited number of possible values help to complete | |
| 557 | 1642 them |
| 859 | 1643 - complete names of entities (defined in |xml-omni-datafile| and in the |
| 1644 current file with "<!ENTITY" declarations) | |
| 557 | 1645 - when used after "</" CTRL-X CTRL-O will close the last opened tag |
| 1646 | |
| 625 | 1647 Format of XML data file *xml-omni-datafile* |
| 557 | 1648 |
| 859 | 1649 XML data files are stored in the "autoload/xml" directory in 'runtimepath'. |
| 1650 Vim distribution provides examples of data files in the | |
| 1651 "$VIMRUNTIME/autoload/xml" directory. They have a meaningful name which will | |
| 1652 be used in commands. It should be a unique name which will not create | |
| 1653 conflicts. For example, the name xhtml10s.vim means it is the data file for | |
| 1654 XHTML 1.0 Strict. | |
| 557 | 1655 |
| 859 | 1656 Each file contains a variable with a name like g:xmldata_xhtml10s . It is |
| 1657 a compound from two parts: | |
| 557 | 1658 |
| 859 | 1659 1. "g:xmldata_" general prefix, constant for all data files |
| 1660 2. "xhtml10s" the name of the file and the name of the described XML | |
| 1661 dialect; it will be used as an argument for the |:XMLns| | |
| 1662 command | |
| 557 | 1663 |
| 1664 Part two must be exactly the same as name of file. | |
| 1665 | |
| 859 | 1666 The variable is a |Dictionary|. Keys are tag names and each value is a two |
| 1667 element |List|. The first element of the List is also a List with the names | |
| 1668 of possible children. The second element is a |Dictionary| with the names of | |
| 1669 attributes as keys and the possible values of attributes as values. Example: > | |
| 557 | 1670 |
| 859 | 1671 let g:xmldata_crippled = { |
| 1672 \ "vimxmlentities": ["amp", "lt", "gt", "apos", "quot"], | |
| 1673 \ 'vimxmlroot': ['tag1'], | |
| 1674 \ 'tag1': | |
| 1675 \ [ ['childoftag1a', 'childoftag1b'], {'attroftag1a': [], | |
| 1676 \ 'attroftag1b': ['valueofattr1', 'valueofattr2']}], | |
| 1677 \ 'childoftag1a': | |
| 1678 \ [ [], {'attrofchild': ['attrofchild']}], | |
| 1679 \ 'childoftag1b': | |
| 1680 \ [ ['childoftag1a'], {'attrofchild': []}], | |
| 667 | 1681 \ "vimxmltaginfo": { |
| 859 | 1682 \ 'tag1': ['Menu info', 'Long information visible in preview window']}, |
| 1683 \ 'vimxmlattrinfo': { | |
| 1684 \ 'attrofchild': ['Menu info', 'Long information visible in preview window']}} | |
| 557 | 1685 |
| 859 | 1686 This example would be put in the "autoload/xml/crippled.vim" file and could |
| 1687 help to write this file: > | |
| 557 | 1688 |
| 859 | 1689 <tag1 attroftag1b="valueofattr1"> |
| 1690 <childoftag1a attrofchild> | |
| 1691 & < | |
| 1692 </childoftag1a> | |
| 1693 <childoftag1b attrofchild="5"> | |
| 1694 <childoftag1a> | |
| 1695 > ' " | |
| 1696 </childoftag1a> | |
| 1697 </childoftag1b> | |
| 1698 </tag1> | |
| 1699 | |
| 1700 In the example four special elements are visible: | |
| 1701 | |
| 1702 1. "vimxmlentities" - a special key with List containing entities of this XML | |
| 557 | 1703 dialect. |
| 859 | 1704 2. If the list containing possible values of attributes has one element and |
| 1705 this element is equal to the name of the attribute this attribute will be | |
| 1706 treated as boolean and inserted as 'attrname' and not as 'attrname="' | |
| 1707 3. "vimxmltaginfo" - a special key with a Dictionary containing tag | |
| 1708 names as keys and two element List as values, for additional menu info and | |
| 1709 the long description. | |
| 1710 4. "vimxmlattrinfo" - special key with Dictionary containing attribute names | |
| 1711 as keys and two element List as values, for additional menu info and long | |
| 667 | 1712 description. |
| 557 | 1713 |
| 859 | 1714 Note: Tag names in the data file MUST not contain a namespace description. |
| 1715 Check xsl.vim for an example. | |
| 1716 Note: All data and functions are publicly available as global | |
| 1717 variables/functions and can be used for personal editing functions. | |
| 557 | 1718 |
| 667 | 1719 |
| 856 | 1720 DTD -> Vim *dtd2vim* |
| 836 | 1721 |
| 859 | 1722 On |www| is the script |dtd2vim| which parses DTD and creates an XML data file |
| 836 | 1723 for Vim XML omni completion. |
| 1724 | |
| 1725 dtd2vim: http://www.vim.org/scripts/script.php?script_id=1462 | |
| 1726 | |
| 859 | 1727 Check the beginning of that file for usage details. |
| 1728 The script requires perl and: | |
| 836 | 1729 |
| 1730 perlSGML: http://savannah.nongnu.org/projects/perlsgml | |
| 1731 | |
| 1732 | |
| 557 | 1733 Commands |
| 1734 | |
| 625 | 1735 :XMLns {name} [{namespace}] *:XMLns* |
| 557 | 1736 |
| 859 | 1737 Vim has to know which data file should be used and with which namespace. For |
| 1738 loading of the data file and connecting data with the proper namespace use | |
| 1739 |:XMLns| command. The first (obligatory) argument is the name of the data | |
| 1740 (xhtml10s, xsl). The second argument is the code of namespace (h, xsl). When | |
| 1741 used without a second argument the dialect will be used as default - without | |
| 1742 namespace declaration. For example to use XML completion in .xsl files: > | |
| 557 | 1743 |
| 1744 :XMLns xhtml10s | |
| 1745 :XMLns xsl xsl | |
| 1746 | |
| 1747 | |
| 625 | 1748 :XMLent {name} *:XMLent* |
| 557 | 1749 |
| 859 | 1750 By default entities will be completed from the data file of the default |
| 1751 namespace. The XMLent command should be used in case when there is no default | |
| 1752 namespace: > | |
| 557 | 1753 |
| 625 | 1754 :XMLent xhtml10s |
| 557 | 1755 |
| 1756 Usage | |
| 1757 | |
| 859 | 1758 While used in this situation (after declarations from previous part, | is |
| 557 | 1759 cursor position): > |
| 1760 | |
| 625 | 1761 <| |
| 557 | 1762 |
| 859 | 1763 Will complete to an appropriate XHTML tag, and in this situation: > |
| 557 | 1764 |
| 625 | 1765 <xsl:| |
| 557 | 1766 |
| 859 | 1767 Will complete to an appropriate XSL tag. |
| 1768 | |
| 557 | 1769 |
| 859 | 1770 The script xmlcomplete.vim, provided through the |autoload| mechanism, |
| 1771 has the xmlcomplete#GetLastOpenTag() function which can be used in XML files | |
| 1772 to get the name of the last open tag (b:unaryTagsStack has to be defined): > | |
| 529 | 1773 |
| 625 | 1774 :echo xmlcomplete#GetLastOpenTag("b:unaryTagsStack") |
| 531 | 1775 |
| 529 | 1776 |
| 532 | 1777 |
| 7 | 1778 ============================================================================== |
| 1779 8. Insert mode commands *inserting* | |
| 1780 | |
| 1781 The following commands can be used to insert new text into the buffer. They | |
| 1782 can all be undone and repeated with the "." command. | |
| 1783 | |
| 1784 *a* | |
| 1785 a Append text after the cursor [count] times. If the | |
| 1786 cursor is in the first column of an empty line Insert | |
| 1787 starts there. But not when 'virtualedit' is set! | |
| 1788 | |
| 1789 *A* | |
| 1790 A Append text at the end of the line [count] times. | |
| 1791 | |
| 1792 <insert> or *i* *insert* *<Insert>* | |
| 1793 i Insert text before the cursor [count] times. | |
| 1794 When using CTRL-O in Insert mode |i_CTRL-O| the count | |
| 1795 is not supported. | |
| 1796 | |
| 1797 *I* | |
| 1798 I Insert text before the first non-blank in the line | |
| 1799 [count] times. | |
| 164 | 1800 When the 'H' flag is present in 'cpoptions' and the |
| 1801 line only contains blanks, insert start just before | |
| 1802 the last blank. | |
| 7 | 1803 |
| 1804 *gI* | |
| 1805 gI Insert text in column 1 [count] times. {not in Vi} | |
| 1806 | |
| 1807 *gi* | |
| 1808 gi Insert text in the same position as where Insert mode | |
| 1809 was stopped last time in the current buffer. | |
| 1810 This uses the |'^| mark. It's different from "`^i" | |
| 1811 when the mark is past the end of the line. | |
| 1812 The position is corrected for inserted/deleted lines, | |
| 1813 but NOT for inserted/deleted characters. | |
| 1814 When the |:keepjumps| command modifier is used the |'^| | |
| 9 | 1815 mark won't be changed. |
| 7 | 1816 {not in Vi} |
| 1817 | |
| 1818 *o* | |
| 1819 o Begin a new line below the cursor and insert text, | |
| 1820 repeat [count] times. {Vi: blank [count] screen | |
| 1821 lines} | |
| 164 | 1822 When the '#' flag is in 'cpoptions' the count is |
| 1823 ignored. | |
| 7 | 1824 |
| 1825 *O* | |
| 1826 O Begin a new line above the cursor and insert text, | |
| 1827 repeat [count] times. {Vi: blank [count] screen | |
| 1828 lines} | |
| 164 | 1829 When the '#' flag is in 'cpoptions' the count is |
| 1830 ignored. | |
| 7 | 1831 |
| 1832 These commands are used to start inserting text. You can end insert mode with | |
| 1833 <Esc>. See |mode-ins-repl| for the other special characters in Insert mode. | |
| 1834 The effect of [count] takes place after Insert mode is exited. | |
| 1835 | |
| 1836 When 'autoindent' is on, the indent for a new line is obtained from the | |
| 1837 previous line. When 'smartindent' or 'cindent' is on, the indent for a line | |
| 1838 is automatically adjusted for C programs. | |
| 1839 | |
| 1840 'textwidth' can be set to the maximum width for a line. When a line becomes | |
| 1841 too long when appending characters a line break is automatically inserted. | |
| 1842 | |
| 1843 | |
| 1844 ============================================================================== | |
| 1845 9. Ex insert commands *inserting-ex* | |
| 1846 | |
| 1847 *:a* *:append* | |
| 167 | 1848 :{range}a[ppend][!] Insert several lines of text below the specified |
| 7 | 1849 line. If the {range} is missing, the text will be |
| 1850 inserted after the current line. | |
| 167 | 1851 Adding [!] toggles 'autoindent' for the time this |
| 1852 command is executed. | |
| 7 | 1853 |
| 1854 *:i* *:in* *:insert* | |
| 167 | 1855 :{range}i[nsert][!] Insert several lines of text above the specified |
| 7 | 1856 line. If the {range} is missing, the text will be |
| 1857 inserted before the current line. | |
| 167 | 1858 Adding [!] toggles 'autoindent' for the time this |
| 1859 command is executed. | |
| 7 | 1860 |
| 1861 These two commands will keep on asking for lines, until you type a line | |
| 1862 containing only a ".". Watch out for lines starting with a backslash, see | |
| 1863 |line-continuation|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1864 |
| 2596 | 1865 When in Ex mode (see |-e|) a backslash at the end of the line can be used to |
| 1866 insert a NUL character. To be able to have a line ending in a backslash use | |
| 1867 two backslashes. This means that the number of backslashes is halved, but | |
| 1868 only at the end of the line. | |
| 1869 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1870 NOTE: These commands cannot be used with |:global| or |:vglobal|. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1871 ":append" and ":insert" don't work properly in between ":if" and |
| 74 | 1872 ":endif", ":for" and ":endfor", ":while" and ":endwhile". |
| 7 | 1873 |
| 1874 *:start* *:startinsert* | |
| 1875 :star[tinsert][!] Start Insert mode just after executing this command. | |
| 1876 Works like typing "i" in Normal mode. When the ! is | |
| 1877 included it works like "A", append to the line. | |
| 1878 Otherwise insertion starts at the cursor position. | |
| 1879 Note that when using this command in a function or | |
| 1880 script, the insertion only starts after the function | |
| 1881 or script is finished. | |
| 446 | 1882 This command does not work from |:normal|. |
| 7 | 1883 {not in Vi} |
| 1884 | |
| 1885 *:stopi* *:stopinsert* | |
| 1886 :stopi[nsert] Stop Insert mode as soon as possible. Works like | |
| 1887 typing <Esc> in Insert mode. | |
| 1888 Can be used in an autocommand, example: > | |
| 1889 :au BufEnter scratch stopinsert | |
| 14 | 1890 < |
| 1891 *replacing-ex* *:startreplace* | |
| 1892 :startr[eplace][!] Start Replace mode just after executing this command. | |
| 1893 Works just like typing "R" in Normal mode. When the | |
| 1894 ! is included it acts just like "$R" had been typed | |
| 1895 (ie. begin replace mode at the end-of-line). Other- | |
| 1896 wise replacement begins at the cursor position. | |
| 1897 Note that when using this command in a function or | |
| 1898 script that the replacement will only start after | |
| 1899 the function or script is finished. | |
| 1900 {not in Vi} | |
| 7 | 1901 |
| 599 | 1902 *:startgreplace* |
| 1903 :startg[replace][!] Just like |:startreplace|, but use Virtual Replace | |
| 1904 mode, like with |gR|. | |
| 1905 {not in Vi} | |
| 1906 | |
| 7 | 1907 ============================================================================== |
| 1908 10. Inserting a file *inserting-file* | |
| 1909 | |
| 1910 *:r* *:re* *:read* | |
| 819 | 1911 :r[ead] [++opt] [name] |
| 1912 Insert the file [name] (default: current file) below | |
| 7 | 1913 the cursor. |
| 819 | 1914 See |++opt| for the possible values of [++opt]. |
| 7 | 1915 |
| 819 | 1916 :{range}r[ead] [++opt] [name] |
| 1917 Insert the file [name] (default: current file) below | |
| 7 | 1918 the specified line. |
| 819 | 1919 See |++opt| for the possible values of [++opt]. |
| 7 | 1920 |
| 1921 *:r!* *:read!* | |
| 4278 | 1922 :[range]r[ead] [++opt] !{cmd} |
| 1923 Execute {cmd} and insert its standard output below | |
| 1121 | 1924 the cursor or the specified line. A temporary file is |
| 1925 used to store the output of the command which is then | |
| 1926 read into the buffer. 'shellredir' is used to save | |
| 1927 the output of the command, which can be set to include | |
| 1928 stderr or not. {cmd} is executed like with ":!{cmd}", | |
| 1929 any '!' is replaced with the previous command |:!|. | |
| 4278 | 1930 See |++opt| for the possible values of [++opt]. |
| 7 | 1931 |
| 1932 These commands insert the contents of a file, or the output of a command, | |
| 1933 into the buffer. They can be undone. They cannot be repeated with the "." | |
| 1934 command. They work on a line basis, insertion starts below the line in which | |
| 1935 the cursor is, or below the specified line. To insert text above the first | |
| 1936 line use the command ":0r {name}". | |
| 1937 | |
| 1938 After the ":read" command, the cursor is left on the first non-blank in the | |
| 1939 first new line. Unless in Ex mode, then the cursor is left on the last new | |
| 1940 line (sorry, this is Vi compatible). | |
| 1941 | |
| 1942 If a file name is given with ":r", it becomes the alternate file. This can be | |
| 1943 used, for example, when you want to edit that file instead: ":e! #". This can | |
| 1944 be switched off by removing the 'a' flag from the 'cpoptions' option. | |
| 1945 | |
| 819 | 1946 Of the [++opt] arguments one is specifically for ":read", the ++edit argument. |
| 1947 This is useful when the ":read" command is actually used to read a file into | |
| 1948 the buffer as if editing that file. Use this command in an empty buffer: > | |
| 1949 :read ++edit filename | |
| 1950 The effect is that the 'fileformat', 'fileencoding', 'bomb', etc. options are | |
| 1951 set to what has been detected for "filename". Note that a single empty line | |
| 1952 remains, you may want to delete it. | |
| 1953 | |
| 7 | 1954 *file-read* |
| 1955 The 'fileformat' option sets the <EOL> style for a file: | |
| 1956 'fileformat' characters name ~ | |
| 1957 "dos" <CR><NL> or <NL> DOS format | |
| 1958 "unix" <NL> Unix format | |
| 1959 "mac" <CR> Mac format | |
| 1960 Previously 'textmode' was used. It is obsolete now. | |
| 1961 | |
| 1962 If 'fileformat' is "dos", a <CR> in front of an <NL> is ignored and a CTRL-Z | |
| 1963 at the end of the file is ignored. | |
| 1964 | |
| 1965 If 'fileformat' is "mac", a <NL> in the file is internally represented by a | |
| 1966 <CR>. This is to avoid confusion with a <NL> which is used to represent a | |
| 1967 <NUL>. See |CR-used-for-NL|. | |
| 1968 | |
| 1969 If the 'fileformats' option is not empty Vim tries to recognize the type of | |
| 1970 <EOL> (see |file-formats|). However, the 'fileformat' option will not be | |
| 1971 changed, the detected format is only used while reading the file. | |
| 1972 A similar thing happens with 'fileencodings'. | |
| 1973 | |
| 1974 On non-MS-DOS, Win32, and OS/2 systems the message "[dos format]" is shown if | |
| 1975 a file is read in DOS format, to remind you that something unusual is done. | |
| 1976 On Macintosh, MS-DOS, Win32, and OS/2 the message "[unix format]" is shown if | |
| 1977 a file is read in Unix format. | |
| 1978 On non-Macintosh systems, the message "[Mac format]" is shown if a file is | |
| 1979 read in Mac format. | |
| 1980 | |
| 1981 An example on how to use ":r !": > | |
| 1982 :r !uuencode binfile binfile | |
| 1983 This command reads "binfile", uuencodes it and reads it into the current | |
| 1984 buffer. Useful when you are editing e-mail and want to include a binary | |
| 1985 file. | |
| 1986 | |
| 1987 *read-messages* | |
| 1988 When reading a file Vim will display a message with information about the read | |
| 1989 file. In the table is an explanation for some of the items. The others are | |
| 1990 self explanatory. Using the long or the short version depends on the | |
| 1991 'shortmess' option. | |
| 1992 | |
| 1993 long short meaning ~ | |
| 1994 [readonly] {RO} the file is write protected | |
| 1995 [fifo/socket] using a stream | |
| 1996 [fifo] using a fifo stream | |
| 1997 [socket] using a socket stream | |
| 1998 [CR missing] reading with "dos" 'fileformat' and a | |
| 1999 NL without a preceding CR was found. | |
| 2000 [NL found] reading with "mac" 'fileformat' and a | |
| 2001 NL was found (could be "unix" format) | |
| 2002 [long lines split] at least one line was split in two | |
| 2003 [NOT converted] conversion from 'fileencoding' to | |
| 2004 'encoding' was desired but not | |
| 2005 possible | |
| 2006 [converted] conversion from 'fileencoding' to | |
| 2007 'encoding' done | |
| 2008 [crypted] file was decrypted | |
| 2009 [READ ERRORS] not all of the file could be read | |
| 2010 | |
| 2011 | |
| 14421 | 2012 vim:tw=78:ts=8:noet:ft=help:norl: |