Mercurial > vim
annotate runtime/doc/fold.txt @ 7098:70b56e5eccb2 v7.4.861
commit https://github.com/vim/vim/commit/3cbe0c01ad71875bd662edb629f9e792a734f292
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Sep 8 20:00:22 2015 +0200
patch 7.4.861
Problem: pango_shape_full() is not always available.
Solution: Add a configure check.
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Tue, 08 Sep 2015 20:15:03 +0200 |
parents | bc62d1988bf2 |
children | 17333ebd2bbd |
rev | line source |
---|---|
5555 | 1 *fold.txt* For Vim version 7.4. Last change: 2013 Dec 04 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
7 Folding *Folding* *folding* *folds* |
7 | 8 |
9 You can find an introduction on folding in chapter 28 of the user manual. | |
10 |usr_28.txt| | |
11 | |
12 1. Fold methods |fold-methods| | |
13 2. Fold commands |fold-commands| | |
14 3. Fold options |fold-options| | |
15 4. Behavior of folds |fold-behavior| | |
16 | |
17 {Vi has no Folding} | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
18 {not available when compiled without the |+folding| feature} |
7 | 19 |
20 ============================================================================== | |
21 1. Fold methods *fold-methods* | |
22 | |
23 The folding method can be set with the 'foldmethod' option. | |
24 | |
25 When setting 'foldmethod' to a value other than "manual", all folds are | |
26 deleted and new ones created. Switching to the "manual" method doesn't remove | |
27 the existing folds. This can be used to first define the folds automatically | |
28 and then change them manually. | |
29 | |
30 There are six methods to select folds: | |
31 manual manually define folds | |
32 indent more indent means a higher fold level | |
33 expr specify an expression to define folds | |
34 syntax folds defined by syntax highlighting | |
35 diff folds for unchanged text | |
36 marker folds defined by markers in the text | |
37 | |
38 | |
39 MANUAL *fold-manual* | |
40 | |
41 Use commands to manually define the fold regions. This can also be used by a | |
42 script that parses text to find folds. | |
43 | |
44 The level of a fold is only defined by its nesting. To increase the fold | |
45 level of a fold for a range of lines, define a fold inside it that has the | |
46 same lines. | |
47 | |
48 The manual folds are lost when you abandon the file. To save the folds use | |
49 the |:mkview| command. The view can be restored later with |:loadview|. | |
50 | |
51 | |
52 INDENT *fold-indent* | |
53 | |
54 The folds are automatically defined by the indent of the lines. | |
55 | |
56 The foldlevel is computed from the indent of the line, divided by the | |
57 'shiftwidth' (rounded down). A sequence of lines with the same or higher fold | |
58 level form a fold, with the lines with a higher level forming a nested fold. | |
59 | |
60 The nesting of folds is limited with 'foldnestmax'. | |
61 | |
62 Some lines are ignored and get the fold level of the line above or below it, | |
2826 | 63 whichever is lower. These are empty or white lines and lines starting |
7 | 64 with a character in 'foldignore'. White space is skipped before checking for |
65 characters in 'foldignore'. For C use "#" to ignore preprocessor lines. | |
66 | |
67 When you want to ignore lines in another way, use the 'expr' method. The | |
68 |indent()| function can be used in 'foldexpr' to get the indent of a line. | |
69 | |
70 | |
71 EXPR *fold-expr* | |
72 | |
73 The folds are automatically defined by their foldlevel, like with the "indent" | |
74 method. The value of the 'foldexpr' option is evaluated to get the foldlevel | |
75 of a line. Examples: | |
1255 | 76 This will create a fold for all consecutive lines that start with a tab: > |
7 | 77 :set foldexpr=getline(v:lnum)[0]==\"\\t\" |
78 This will call a function to compute the fold level: > | |
79 :set foldexpr=MyFoldLevel(v:lnum) | |
80 This will make a fold out of paragraphs separated by blank lines: > | |
81 :set foldexpr=getline(v:lnum)=~'^\\s*$'&&getline(v:lnum+1)=~'\\S'?'<1':1 | |
82 this does the same: > | |
83 :set foldexpr=getline(v:lnum-1)=~'^\\s*$'&&getline(v:lnum)=~'\\S'?'>1':1 | |
84 | |
85 Note that backslashes must be used to escape characters that ":set" handles | |
86 differently (space, backslash, double quote, etc., see |option-backslash|). | |
87 | |
88 These are the conditions with which the expression is evaluated: | |
89 - The current buffer and window are set for the line. | |
90 - The variable "v:lnum" is set to the line number. | |
91 - The result is used for the fold level in this way: | |
92 value meaning ~ | |
93 0 the line is not in a fold | |
94 1, 2, .. the line is in a fold with this level | |
95 -1 the fold level is undefined, use the fold level of a | |
96 line before or after this line, whichever is the | |
97 lowest. | |
98 "=" use fold level from the previous line | |
99 "a1", "a2", .. add one, two, .. to the fold level of the previous | |
100 line | |
101 "s1", "s2", .. subtract one, two, .. from the fold level of the | |
102 previous line | |
103 "<1", "<2", .. a fold with this level ends at this line | |
104 ">1", ">2", .. a fold with this level starts at this line | |
105 | |
106 It is not required to mark the start (end) of a fold with ">1" ("<1"), a fold | |
107 will also start (end) when the fold level is higher (lower) than the fold | |
108 level of the previous line. | |
109 | |
110 There must be no side effects from the expression. The text in the buffer, | |
111 cursor position, the search patterns, options etc. must not be changed. | |
818 | 112 You can change and restore them if you are careful. |
7 | 113 |
114 If there is some error in the expression, or the resulting value isn't | |
115 recognized, there is no error message and the fold level will be zero. | |
116 For debugging the 'debug' option can be set to "msg", the error messages will | |
117 be visible then. | |
118 | |
119 Note: Since the expression has to be evaluated for every line, this fold | |
120 method can be very slow! | |
121 | |
122 Try to avoid the "=", "a" and "s" return values, since Vim often has to search | |
123 backwards for a line for which the fold level is defined. This can be slow. | |
124 | |
125 |foldlevel()| can be useful to compute a fold level relative to a previous | |
126 fold level. But note that foldlevel() may return -1 if the level is not known | |
127 yet. And it returns the level at the start of the line, while a fold might | |
128 end in that line. | |
129 | |
2152 | 130 It may happened that folds are not updated properly. You can use |zx| or |zX| |
131 to force updating folds. | |
132 | |
7 | 133 |
134 SYNTAX *fold-syntax* | |
135 | |
136 A fold is defined by syntax items that have the "fold" argument. |:syn-fold| | |
137 | |
138 The fold level is defined by nesting folds. The nesting of folds is limited | |
139 with 'foldnestmax'. | |
140 | |
141 Be careful to specify proper syntax syncing. If this is not done right, folds | |
142 may differ from the displayed highlighting. This is especially relevant when | |
143 using patterns that match more than one line. In case of doubt, try using | |
144 brute-force syncing: > | |
145 :syn sync fromstart | |
146 | |
147 | |
148 DIFF *fold-diff* | |
149 | |
150 The folds are automatically defined for text that is not part of a change or | |
151 close to a change. | |
152 | |
153 This method only works properly when the 'diff' option is set for the current | |
154 window and changes are being displayed. Otherwise the whole buffer will be | |
155 one big fold. | |
156 | |
157 The 'diffopt' option can be used to specify the context. That is, the number | |
158 of lines between the fold and a change that are not included in the fold. For | |
159 example, to use a context of 8 lines: > | |
160 :set diffopt=filler,context:8 | |
161 The default context is six lines. | |
162 | |
163 When 'scrollbind' is also set, Vim will attempt to keep the same folds open in | |
164 other diff windows, so that the same text is visible. | |
165 | |
166 | |
167 MARKER *fold-marker* | |
168 | |
169 Markers in the text tell where folds start and end. This allows you to | |
170 precisely specify the folds. This will allow deleting and putting a fold, | |
171 without the risk of including the wrong lines. The 'foldtext' option is | |
172 normally set such that the text before the marker shows up in the folded line. | |
173 This makes it possible to give a name to the fold. | |
174 | |
175 Markers can have a level included, or can use matching pairs. Including a | |
176 level is easier, you don't have to add end markers and avoid problems with | |
177 non-matching marker pairs. Example: > | |
178 /* global variables {{{1 */ | |
179 int varA, varB; | |
180 | |
181 /* functions {{{1 */ | |
182 /* funcA() {{{2 */ | |
183 void funcA() {} | |
184 | |
185 /* funcB() {{{2 */ | |
186 void funcB() {} | |
187 | |
188 A fold starts at a "{{{" marker. The following number specifies the fold | |
189 level. What happens depends on the difference between the current fold level | |
190 and the level given by the marker: | |
191 1. If a marker with the same fold level is encountered, the previous fold | |
192 ends and another fold with the same level starts. | |
193 2. If a marker with a higher fold level is found, a nested fold is started. | |
194 3. if a marker with a lower fold level is found, all folds up to and including | |
195 this level end and a fold with the specified level starts. | |
196 | |
33 | 197 The number indicates the fold level. A zero cannot be used (a marker with |
198 level zero is ignored). You can use "}}}" with a digit to indicate the level | |
199 of the fold that ends. The fold level of the following line will be one less | |
200 than the indicated level. Note that Vim doesn't look back to the level of the | |
201 matching marker (that would take too much time). Example: > | |
7 | 202 |
203 {{{1 | |
204 fold level here is 1 | |
205 {{{3 | |
206 fold level here is 3 | |
207 }}}3 | |
208 fold level here is 2 | |
209 | |
210 You can also use matching pairs of "{{{" and "}}}" markers to define folds. | |
211 Each "{{{" increases the fold level by one, each "}}}" decreases the fold | |
212 level by one. Be careful to keep the markers matching! Example: > | |
213 | |
214 {{{ | |
215 fold level here is 1 | |
216 {{{ | |
217 fold level here is 2 | |
218 }}} | |
219 fold level here is 1 | |
220 | |
221 You can mix using markers with a number and without a number. A useful way of | |
222 doing this is to use numbered markers for large folds, and unnumbered markers | |
223 locally in a function. For example use level one folds for the sections of | |
224 your file like "structure definitions", "local variables" and "functions". | |
225 Use level 2 markers for each definition and function, Use unnumbered markers | |
226 inside functions. When you make changes in a function to split up folds, you | |
227 don't have to renumber the markers. | |
228 | |
229 The markers can be set with the 'foldmarker' option. It is recommended to | |
230 keep this at the default value of "{{{,}}}", so that files can be exchanged | |
231 between Vim users. Only change it when it is required for the file (e.g., it | |
232 contains markers from another folding editor, or the default markers cause | |
233 trouble for the language of the file). | |
234 | |
235 *fold-create-marker* | |
236 "zf" can be used to create a fold defined by markers. Vim will insert the | |
237 markers for you. Vim will append the start and end marker, as specified with | |
238 'foldmarker'. The markers are appended to the end of the line. | |
239 'commentstring' is used if it isn't empty. | |
240 This does not work properly when: | |
241 - The line already contains a marker with a level number. Vim then doesn't | |
242 know what to do. | |
243 - Folds nearby use a level number in their marker which gets in the way. | |
244 - The line is inside a comment, 'commentstring' isn't empty and nested | |
245 comments don't work. For example with C: adding /* {{{ */ inside a comment | |
246 will truncate the existing comment. Either put the marker before or after | |
247 the comment, or add the marker manually. | |
248 Generally it's not a good idea to let Vim create markers when you already have | |
249 markers with a level number. | |
250 | |
251 *fold-delete-marker* | |
252 "zd" can be used to delete a fold defined by markers. Vim will delete the | |
253 markers for you. Vim will search for the start and end markers, as specified | |
254 with 'foldmarker', at the start and end of the fold. When the text around the | |
255 marker matches with 'commentstring', that text is deleted as well. | |
256 This does not work properly when: | |
257 - A line contains more than one marker and one of them specifies a level. | |
258 Only the first one is removed, without checking if this will have the | |
259 desired effect of deleting the fold. | |
260 - The marker contains a level number and is used to start or end several folds | |
261 at the same time. | |
262 | |
263 ============================================================================== | |
264 2. Fold commands *fold-commands* *E490* | |
265 | |
266 All folding commands start with "z". Hint: the "z" looks like a folded piece | |
267 of paper, if you look at it from the side. | |
268 | |
269 | |
270 CREATING AND DELETING FOLDS ~ | |
271 *zf* *E350* | |
272 zf{motion} or | |
273 {Visual}zf Operator to create a fold. | |
274 This only works when 'foldmethod' is "manual" or "marker". | |
275 The new fold will be closed for the "manual" method. | |
276 'foldenable' will be set. | |
277 Also see |fold-create-marker|. | |
278 | |
279 *zF* | |
2098
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
280 zF Create a fold for [count] lines. Works like "zf". |
7 | 281 |
282 :{range}fo[ld] *:fold* *:fo* | |
283 Create a fold for the lines in {range}. Works like "zf". | |
284 | |
285 *zd* *E351* | |
42 | 286 zd Delete one fold at the cursor. When the cursor is on a folded |
7 | 287 line, that fold is deleted. Nested folds are moved one level |
5555 | 288 up. In Visual mode one level of all folds (partially) in the |
289 selected area are deleted. | |
290 Careful: This easily deletes more folds than you expect and | |
291 there is no undo for manual folding. | |
7 | 292 This only works when 'foldmethod' is "manual" or "marker". |
293 Also see |fold-delete-marker|. | |
294 | |
295 *zD* | |
296 zD Delete folds recursively at the cursor. In Visual mode all | |
297 folds (partially) in the selected area and all nested folds in | |
298 them are deleted. | |
299 This only works when 'foldmethod' is "manual" or "marker". | |
300 Also see |fold-delete-marker|. | |
301 | |
302 *zE* *E352* | |
303 zE Eliminate all folds in the window. | |
304 This only works when 'foldmethod' is "manual" or "marker". | |
305 Also see |fold-delete-marker|. | |
306 | |
307 | |
308 OPENING AND CLOSING FOLDS ~ | |
309 | |
310 A fold smaller than 'foldminlines' will always be displayed like it was open. | |
311 Therefore the commands below may work differently on small folds. | |
312 | |
313 *zo* | |
314 zo Open one fold under the cursor. When a count is given, that | |
315 many folds deep will be opened. In Visual mode one level of | |
316 folds is opened for all lines in the selected area. | |
317 | |
318 *zO* | |
319 zO Open all folds under the cursor recursively. Folds that don't | |
320 contain the cursor line are unchanged. | |
321 In Visual mode it opens all folds that are in the selected | |
322 area, also those that are only partly selected. | |
323 | |
324 *zc* | |
325 zc Close one fold under the cursor. When a count is given, that | |
326 many folds deep are closed. In Visual mode one level of folds | |
327 is closed for all lines in the selected area. | |
328 'foldenable' will be set. | |
329 | |
330 *zC* | |
331 zC Close all folds under the cursor recursively. Folds that | |
332 don't contain the cursor line are unchanged. | |
333 In Visual mode it closes all folds that are in the selected | |
334 area, also those that are only partly selected. | |
335 'foldenable' will be set. | |
336 | |
337 *za* | |
236 | 338 za When on a closed fold: open it. When folds are nested, you |
7 | 339 may have to use "za" several times. When a count is given, |
340 that many closed folds are opened. | |
341 When on an open fold: close it and set 'foldenable'. This | |
342 will only close one level, since using "za" again will open | |
343 the fold. When a count is given that many folds will be | |
344 closed (that's not the same as repeating "za" that many | |
345 times). | |
346 | |
347 *zA* | |
348 zA When on a closed fold: open it recursively. | |
349 When on an open fold: close it recursively and set | |
350 'foldenable'. | |
351 | |
352 *zv* | |
353 zv View cursor line: Open just enough folds to make the line in | |
354 which the cursor is located not folded. | |
355 | |
356 *zx* | |
357 zx Update folds: Undo manually opened and closed folds: re-apply | |
358 'foldlevel', then do "zv": View cursor line. | |
2152 | 359 Also forces recomputing folds. This is useful when using |
360 'foldexpr' and the buffer is changed in a way that results in | |
361 folds not to be updated properly. | |
7 | 362 |
363 *zX* | |
364 zX Undo manually opened and closed folds: re-apply 'foldlevel'. | |
2152 | 365 Also forces recomputing folds, like |zx|. |
7 | 366 |
367 *zm* | |
6725 | 368 zm Fold more: Subtract |v:count1| from 'foldlevel'. If 'foldlevel' was |
7 | 369 already zero nothing happens. |
370 'foldenable' will be set. | |
371 | |
372 *zM* | |
373 zM Close all folds: set 'foldlevel' to 0. | |
374 'foldenable' will be set. | |
375 | |
376 *zr* | |
6725 | 377 zr Reduce folding: Add |v:count1| to 'foldlevel'. |
7 | 378 |
379 *zR* | |
380 zR Open all folds. This sets 'foldlevel' to highest fold level. | |
381 | |
382 *:foldo* *:foldopen* | |
383 :{range}foldo[pen][!] | |
384 Open folds in {range}. When [!] is added all folds are | |
385 opened. Useful to see all the text in {range}. Without [!] | |
386 one level of folds is opened. | |
387 | |
388 *:foldc* *:foldclose* | |
389 :{range}foldc[lose][!] | |
390 Close folds in {range}. When [!] is added all folds are | |
391 closed. Useful to hide all the text in {range}. Without [!] | |
392 one level of folds is closed. | |
393 | |
394 *zn* | |
395 zn Fold none: reset 'foldenable'. All folds will be open. | |
396 | |
397 *zN* | |
398 zN Fold normal: set 'foldenable'. All folds will be as they | |
399 were before. | |
400 | |
401 *zi* | |
402 zi Invert 'foldenable'. | |
403 | |
404 | |
405 MOVING OVER FOLDS ~ | |
406 *[z* | |
407 [z Move to the start of the current open fold. If already at the | |
408 start, move to the start of the fold that contains it. If | |
409 there is no containing fold, the command fails. | |
2098
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
410 When a count is used, repeats the command [count] times. |
7 | 411 |
412 *]z* | |
413 ]z Move to the end of the current open fold. If already at the | |
414 end, move to the end of the fold that contains it. If there | |
415 is no containing fold, the command fails. | |
2098
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
416 When a count is used, repeats the command [count] times. |
7 | 417 |
418 *zj* | |
419 zj Move downwards to the start of the next fold. A closed fold | |
420 is counted as one fold. | |
2098
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
421 When a count is used, repeats the command [count] times. |
7 | 422 This command can be used after an |operator|. |
423 | |
424 *zk* | |
425 zk Move upwards to the end of the previous fold. A closed fold | |
426 is counted as one fold. | |
2098
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
427 When a count is used, repeats the command [count] times. |
7 | 428 This command can be used after an |operator|. |
429 | |
430 | |
431 EXECUTING COMMANDS ON FOLDS ~ | |
432 | |
433 :[range]foldd[oopen] {cmd} *:foldd* *:folddoopen* | |
434 Execute {cmd} on all lines that are not in a closed fold. | |
435 When [range] is given, only these lines are used. | |
436 Each time {cmd} is executed the cursor is positioned on the | |
437 line it is executed for. | |
438 This works like the ":global" command: First all lines that | |
439 are not in a closed fold are marked. Then the {cmd} is | |
440 executed for all marked lines. Thus when {cmd} changes the | |
441 folds, this has no influence on where it is executed (except | |
442 when lines are deleted, of course). | |
443 Example: > | |
444 :folddoopen s/end/loop_end/ge | |
445 < Note the use of the "e" flag to avoid getting an error message | |
446 where "end" doesn't match. | |
447 | |
448 :[range]folddoc[losed] {cmd} *:folddoc* *:folddoclosed* | |
449 Execute {cmd} on all lines that are in a closed fold. | |
450 Otherwise like ":folddoopen". | |
451 | |
452 ============================================================================== | |
453 3. Fold options *fold-options* | |
454 | |
455 COLORS *fold-colors* | |
456 | |
457 The colors of a closed fold are set with the Folded group |hl-Folded|. The | |
458 colors of the fold column are set with the FoldColumn group |hl-FoldColumn|. | |
459 Example to set the colors: > | |
460 | |
461 :highlight Folded guibg=grey guifg=blue | |
462 :highlight FoldColumn guibg=darkgrey guifg=white | |
463 | |
464 | |
465 FOLDLEVEL *fold-foldlevel* | |
466 | |
467 'foldlevel' is a number option: The higher the more folded regions are open. | |
468 When 'foldlevel' is 0, all folds are closed. | |
42 | 469 When 'foldlevel' is positive, some folds are closed. |
7 | 470 When 'foldlevel' is very high, all folds are open. |
471 'foldlevel' is applied when it is changed. After that manually folds can be | |
472 opened and closed. | |
473 When increased, folds above the new level are opened. No manually opened | |
474 folds will be closed. | |
475 When decreased, folds above the new level are closed. No manually closed | |
476 folds will be opened. | |
477 | |
478 | |
479 FOLDTEXT *fold-foldtext* | |
480 | |
481 'foldtext' is a string option that specifies an expression. This expression | |
482 is evaluated to obtain the text displayed for a closed fold. Example: > | |
483 | |
484 :set foldtext=v:folddashes.substitute(getline(v:foldstart),'/\\*\\\|\\*/\\\|{{{\\d\\=','','g') | |
485 | |
486 This shows the first line of the fold, with "/*", "*/" and "{{{" removed. | |
487 Note the use of backslashes to avoid some characters to be interpreted by the | |
488 ":set" command. It's simpler to define a function and call that: > | |
489 | |
490 :set foldtext=MyFoldText() | |
491 :function MyFoldText() | |
492 : let line = getline(v:foldstart) | |
493 : let sub = substitute(line, '/\*\|\*/\|{{{\d\=', '', 'g') | |
494 : return v:folddashes . sub | |
495 :endfunction | |
496 | |
497 Evaluating 'foldtext' is done in the |sandbox|. The current window is set to | |
498 the window that displays the line. Errors are ignored. | |
499 | |
500 The default value is |foldtext()|. This returns a reasonable text for most | |
501 types of folding. If you don't like it, you can specify your own 'foldtext' | |
502 expression. It can use these special Vim variables: | |
503 v:foldstart line number of first line in the fold | |
504 v:foldend line number of last line in the fold | |
505 v:folddashes a string that contains dashes to represent the | |
506 foldlevel. | |
507 v:foldlevel the foldlevel of the fold | |
508 | |
509 In the result a TAB is replaced with a space and unprintable characters are | |
510 made into printable characters. | |
511 | |
512 The resulting line is truncated to fit in the window, it never wraps. | |
513 When there is room after the text, it is filled with the character specified | |
514 by 'fillchars'. | |
515 | |
516 Note that backslashes need to be used for characters that the ":set" command | |
517 handles differently: Space, backslash and double-quote. |option-backslash| | |
518 | |
519 | |
520 FOLDCOLUMN *fold-foldcolumn* | |
521 | |
522 'foldcolumn' is a number, which sets the width for a column on the side of the | |
523 window to indicate folds. When it is zero, there is no foldcolumn. A normal | |
519 | 524 value is 4 or 5. The minimal useful value is 2, although 1 still provides |
525 some information. The maximum is 12. | |
7 | 526 |
527 An open fold is indicated with a column that has a '-' at the top and '|' | |
528 characters below it. This column stops where the open fold stops. When folds | |
529 nest, the nested fold is one character right of the fold it's contained in. | |
530 | |
531 A closed fold is indicated with a '+'. | |
532 | |
533 Where the fold column is too narrow to display all nested folds, digits are | |
534 shown to indicate the nesting level. | |
535 | |
536 The mouse can also be used to open and close folds by clicking in the | |
537 fold column: | |
538 - Click on a '+' to open the closed fold at this row. | |
539 - Click on any other non-blank character to close the open fold at this row. | |
540 | |
541 | |
542 OTHER OPTIONS | |
543 | |
544 'foldenable' 'fen': Open all folds while not set. | |
545 'foldexpr' 'fde': Expression used for "expr" folding. | |
546 'foldignore' 'fdi': Characters used for "indent" folding. | |
547 'foldmarker' 'fmr': Defined markers used for "marker" folding. | |
548 'foldmethod' 'fdm': Name of the current folding method. | |
549 'foldminlines' 'fml': Minimum number of screen lines for a fold to be | |
550 displayed closed. | |
551 'foldnestmax' 'fdn': Maximum nesting for "indent" and "syntax" folding. | |
552 'foldopen' 'fdo': Which kinds of commands open closed folds. | |
553 'foldclose' 'fcl': When the folds not under the cursor are closed. | |
554 | |
555 ============================================================================== | |
556 4. Behavior of folds *fold-behavior* | |
557 | |
558 When moving the cursor upwards or downwards and when scrolling, the cursor | |
559 will move to the first line of a sequence of folded lines. When the cursor is | |
560 already on a folded line, it moves to the next unfolded line or the next | |
561 closed fold. | |
562 | |
563 While the cursor is on folded lines, the cursor is always displayed in the | |
564 first column. The ruler does show the actual cursor position, but since the | |
565 line is folded, it cannot be displayed there. | |
566 | |
567 Many movement commands handle a sequence of folded lines like an empty line. | |
568 For example, the "w" command stops once in the first column. | |
569 | |
570 When in Insert mode, the cursor line is never folded. That allows you to see | |
571 what you type! | |
572 | |
573 When using an operator, a closed fold is included as a whole. Thus "dl" | |
574 deletes the whole closed fold under the cursor. | |
575 | |
576 For Ex commands the range is adjusted to always start at the first line of a | |
8 | 577 closed fold and end at the last line of a closed fold. Thus this command: > |
7 | 578 :s/foo/bar/g |
579 when used with the cursor on a closed fold, will replace "foo" with "bar" in | |
580 all lines of the fold. | |
581 This does not happen for |:folddoopen| and |:folddoclosed|. | |
582 | |
583 When editing a buffer that has been edited before, the last used folding | |
584 settings are used again. For manual folding the defined folds are restored. | |
585 For all folding methods the manually opened and closed folds are restored. | |
586 If this buffer has been edited in this window, the values from back then are | |
587 used. Otherwise the values from the window where the buffer was edited last | |
588 are used. | |
589 | |
590 ============================================================================== | |
591 vim:tw=78:ts=8:ft=help:norl: |