| 1 |
|
| 2 |
;;;### (autoloads nil "folding" "folding.el" (0 0 0 0)) |
| 3 |
;;; Generated autoloads from ../folding.el |
| 4 |
|
| 5 |
(defvar folding-mode nil "\ |
| 6 |
When Non nil, Folding mode is active in the current buffer.") |
| 7 |
|
| 8 |
(defvar folding-default-keys-function 'folding-bind-default-keys "\ |
| 9 |
*Function or list of functions used to define keys for Folding mode. |
| 10 |
Possible values are: |
| 11 |
folding-bind-default-key |
| 12 |
The standard keymap. |
| 13 |
|
| 14 |
`folding-bind-backward-compatible-keys' |
| 15 |
Keys used by older versions of Folding mode. This function |
| 16 |
does not conform to Emacs 19.29 style conversions concerning |
| 17 |
key bindings. The prefix key is C - c |
| 18 |
|
| 19 |
`folding-bind-outline-compatible-keys' |
| 20 |
Define keys compatible with Outline mode. |
| 21 |
|
| 22 |
`folding-bind-foldout-compatible-keys' |
| 23 |
Define some extra keys compatible with Foldout. |
| 24 |
|
| 25 |
All except `folding-bind-backward-compatible-keys' used the value of |
| 26 |
the variable `folding-mode-prefix-key' as prefix the key. |
| 27 |
The default is C - c @") |
| 28 |
|
| 29 |
(custom-autoload 'folding-default-keys-function "folding" t) |
| 30 |
|
| 31 |
(defvar folding-default-mouse-keys-function 'folding-bind-default-mouse "\ |
| 32 |
*Function to bind default mouse keys to `folding-mode-map'.") |
| 33 |
|
| 34 |
(custom-autoload 'folding-default-mouse-keys-function "folding" t) |
| 35 |
|
| 36 |
(defvar folding-inside-mode-name "Fld" "\ |
| 37 |
*Mode line addition to show inside levels of fold.") |
| 38 |
|
| 39 |
(custom-autoload 'folding-inside-mode-name "folding" t) |
| 40 |
|
| 41 |
(defvar folding-mode-string "Fld" "\ |
| 42 |
*The minor mode string displayed when mode is on.") |
| 43 |
|
| 44 |
(custom-autoload 'folding-mode-string "folding" t) |
| 45 |
|
| 46 |
(defvar folding-mode-hook-no-regexp "RMAIL" "\ |
| 47 |
*Regexp which disable automatic folding mode turn on for certain files.") |
| 48 |
|
| 49 |
(custom-autoload 'folding-mode-hook-no-regexp "folding" t) |
| 50 |
|
| 51 |
(defvar folding-mode-marks-alist nil "\ |
| 52 |
List of (major-mode . fold mark) default combinations to use. |
| 53 |
When Folding mode is started, the major mode is checked, and if there |
| 54 |
are fold marks for that major mode stored in `folding-mode-marks-alist', |
| 55 |
those marks are used by default. If none are found, the default values |
| 56 |
of \"{{{ \" and \"}}}\" are used. |
| 57 |
|
| 58 |
Use function `folding-add-to-marks-list' to add more fold marks. The function |
| 59 |
also explains the alist use in details. |
| 60 |
|
| 61 |
Use function `folding-set-local-variables' if you change the current mode's |
| 62 |
folding marks during the session.") |
| 63 |
|
| 64 |
(autoload 'folding-uninstall-hooks "folding" "\ |
| 65 |
Remove hooks set by folding.") |
| 66 |
|
| 67 |
(autoload 'folding-install-hooks "folding" "\ |
| 68 |
Install folding hooks.") |
| 69 |
|
| 70 |
(autoload 'folding-keep-hooked "folding" "\ |
| 71 |
Make sure hooks are in their places.") |
| 72 |
|
| 73 |
(autoload 'folding-mode-add-find-file-hook "folding" "\ |
| 74 |
Append `folding-mode-find-file-hook' to the list `find-file-hooks'. |
| 75 |
|
| 76 |
This has the effect that afterwards, when a folded file is visited, if |
| 77 |
appropriate Emacs local variable entries are recognized at the end of |
| 78 |
the file, Folding mode is started automatically. |
| 79 |
|
| 80 |
If `inhibit-local-variables' is non-nil, this will not happen regardless |
| 81 |
of the setting of `find-file-hooks'. |
| 82 |
|
| 83 |
To declare a file to be folded, put `folded-file: t' in the file's |
| 84 |
local variables. eg., at the end of a C source file, put: |
| 85 |
|
| 86 |
/* |
| 87 |
Local variables: |
| 88 |
folded-file: t |
| 89 |
*/ |
| 90 |
|
| 91 |
The local variables can be inside a fold." t) |
| 92 |
|
| 93 |
(autoload 'turn-off-folding-mode "folding" "\ |
| 94 |
Turn off folding." t) |
| 95 |
|
| 96 |
(autoload 'turn-on-folding-mode "folding" "\ |
| 97 |
Turn on folding." t) |
| 98 |
|
| 99 |
(autoload 'folding-mode "folding" "\ |
| 100 |
A folding-editor-like minor mode. ARG INTER. |
| 101 |
|
| 102 |
These are the basic commands that Folding mode provides: |
| 103 |
|
| 104 |
\\{folding-mode-map} |
| 105 |
|
| 106 |
Keys starting with `folding-mode-prefix-key' |
| 107 |
|
| 108 |
\\{folding-mode-prefix-map} |
| 109 |
|
| 110 |
folding-convert-buffer-for-printing: |
| 111 |
`\\[folding-convert-buffer-for-printing]' |
| 112 |
Makes a ready-to-print, formatted, unfolded copy in another |
| 113 |
buffer. |
| 114 |
|
| 115 |
Read the documentation for the above functions for more |
| 116 |
information. |
| 117 |
|
| 118 |
Overview |
| 119 |
|
| 120 |
Folds are a way of hierarchically organizing the text in a |
| 121 |
file, so that the text can be viewed and edited at different |
| 122 |
levels. It is similar to Outline mode in that parts of the |
| 123 |
text can be hidden from view. A fold is a region of text, |
| 124 |
surrounded by special \"fold marks\", which act like |
| 125 |
brackets, grouping the text. Fold mark pairs can be nested, |
| 126 |
and they can have titles. When a fold is folded, the text is |
| 127 |
hidden from view, except for the first line, which acts like |
| 128 |
a title for the fold. |
| 129 |
|
| 130 |
Folding mode is a minor mode, designed to cooperate with many |
| 131 |
other major modes, so that many types of text can be folded |
| 132 |
while they are being edited (eg., plain text, program source |
| 133 |
code, Texinfo, etc.). |
| 134 |
|
| 135 |
Folding-mode function |
| 136 |
|
| 137 |
If Folding mode is not called |
| 138 |
interactively (`(folding-called-interactively-p)' is nil), |
| 139 |
and it is called with two or less arguments, all of which are |
| 140 |
nil, then the point will not be altered if |
| 141 |
`folding-folding-on-startup' is set and |
| 142 |
`folding-whole-buffer' is called. This is generally not a |
| 143 |
good thing, as it can leave the point inside a hidden region |
| 144 |
of a fold, but it is required if the local variables set |
| 145 |
\"mode: folding\" when the file is first read (see |
| 146 |
`hack-local-variables'). |
| 147 |
|
| 148 |
Not that you should ever want to, but to call Folding mode |
| 149 |
from a program with the default behavior (toggling the mode), |
| 150 |
call it with something like `(folding-mode nil t)'. |
| 151 |
|
| 152 |
Fold marks |
| 153 |
|
| 154 |
For most types of folded file, lines representing folds have |
| 155 |
\"{{{\" near the beginning. To enter a fold, move the point |
| 156 |
to the folded line and type `\\[folding-shift-in]'. You |
| 157 |
should no longer be able to see the rest of the file, just |
| 158 |
the contents of the fold, which you couldn='t see before. You |
| 159 |
can use `\\[folding-shift-out]' to leave a fold, and you can |
| 160 |
enter and exit folds to move around the structure of the |
| 161 |
file. |
| 162 |
|
| 163 |
All of the text is present in a folded file all of the time. |
| 164 |
It is just hidden. Folded text shows up as a line (the top |
| 165 |
fold mark) with \"...\" at the end. If you are in a fold, the |
| 166 |
mode line displays \"inside n folds Narrow\", and because the |
| 167 |
buffer is narrowed you can='t see outside of the current |
| 168 |
fold='s text. |
| 169 |
|
| 170 |
By arranging sections of a large file in folds, and maybe |
| 171 |
subsections in sub-folds, you can move around a file quickly |
| 172 |
and easily, and only have to scroll through a couple of pages |
| 173 |
at a time. If you pick the titles for the folds carefully, |
| 174 |
they can be a useful form of documentation, and make moving |
| 175 |
though the file a lot easier. In general, searching through a |
| 176 |
folded file for a particular item is much easier than without |
| 177 |
folds. |
| 178 |
|
| 179 |
Managing folds |
| 180 |
|
| 181 |
To make a new fold, set the mark at one end of the text you |
| 182 |
want in the new fold, and move the point to the other end. |
| 183 |
Then type `\\[folding-fold-region]'. The text you selected |
| 184 |
will be made into a fold, and the fold will be entered. If |
| 185 |
you just want a new, empty fold, set the mark where you want |
| 186 |
the fold, and then create a new fold there without moving the |
| 187 |
point. Don='t worry if the point is in the middle of a line of |
| 188 |
text, `folding-fold-region' will not break text in the middle |
| 189 |
of a line. After making a fold, the fold is entered and the |
| 190 |
point is positioned ready to enter a title for the fold. Do |
| 191 |
not delete the fold marks, which are usually something like |
| 192 |
\"{{{\" and \"}}}\". There may also be a bit of fold mark |
| 193 |
which goes after the fold title. |
| 194 |
|
| 195 |
If the fold markers get messed up, or you just want to see |
| 196 |
the whole unfolded file, use `\\[folding-open-buffer]' to |
| 197 |
unfolded the whole file, so you can see all the text and all |
| 198 |
the marks. This is useful for checking/correcting unbalanced |
| 199 |
fold markers, and for searching for things. Use |
| 200 |
`\\[folding-whole-file]' to fold the buffer again. |
| 201 |
|
| 202 |
`folding-shift-out' will attempt to tidy the current fold |
| 203 |
just before exiting it. It will remove any extra blank lines |
| 204 |
at the top and bottom, (outside the fold marks). It will |
| 205 |
then ensure that fold marks exists, and if they are not, will |
| 206 |
add them (after asking). Finally, the number of blank lines |
| 207 |
between the fold marks and the contents of the fold is set to |
| 208 |
1 (by default). |
| 209 |
|
| 210 |
Folding package customizations |
| 211 |
|
| 212 |
If the fold marks are not set on entry to Folding mode, they |
| 213 |
are set to a default for current major mode, as defined by |
| 214 |
`folding-mode-marks-alist' or to \"{{{ \" and \"}}}\" if none |
| 215 |
are specified. |
| 216 |
|
| 217 |
To bind different commands to keys in Folding mode, set the |
| 218 |
bindings in the keymap `folding-mode-map'. |
| 219 |
|
| 220 |
The hooks `folding-mode-hook' and |
| 221 |
`<major-mode-name>-folding-hook' are called before folding |
| 222 |
the buffer and applying the key bindings in |
| 223 |
`folding-mode-map'. This is a good hook to set extra or |
| 224 |
different key bindings in `folding-mode-map'. Note that key |
| 225 |
bindings in `folding-mode-map' are only examined just after |
| 226 |
calling these hooks; new bindings in those maps only take |
| 227 |
effect when Folding mode is being started. The hook |
| 228 |
`folding-load-hook' is called when Folding mode is loaded |
| 229 |
into Emacs. |
| 230 |
|
| 231 |
Mouse behavior |
| 232 |
|
| 233 |
If you want folding to detect point of actual mouse click, |
| 234 |
please see variable `folding-mouse-yank-at-p'. |
| 235 |
|
| 236 |
To customise the mouse actions, look at `folding-behave-table'. |
| 237 |
|
| 238 |
\(fn &optional ARG INTER)" t) |
| 239 |
|
| 240 |
(register-definition-prefixes "folding" '("fold")) |
| 241 |
|
| 242 |
;;;*** |