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