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