Commit | Line | Data |
---|---|---|
6bf7aab6 | 1 | @c This is part of the Emacs manual. |
9577aa62 DL |
2 | @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000 |
3 | @c Free Software Foundation, Inc. | |
6bf7aab6 DL |
4 | @c See file emacs.texi for copying conditions. |
5 | @node Text, Programs, Indentation, Top | |
6 | @chapter Commands for Human Languages | |
7 | @cindex text | |
8 | @cindex manipulating text | |
9 | ||
10 | The term @dfn{text} has two widespread meanings in our area of the | |
11 | computer field. One is data that is a sequence of characters. Any file | |
12 | that you edit with Emacs is text, in this sense of the word. The other | |
13 | meaning is more restrictive: a sequence of characters in a human language | |
14 | for humans to read (possibly after processing by a text formatter), as | |
15 | opposed to a program or commands for a program. | |
16 | ||
17 | Human languages have syntactic/stylistic conventions that can be | |
18 | supported or used to advantage by editor commands: conventions involving | |
19 | words, sentences, paragraphs, and capital letters. This chapter | |
20 | describes Emacs commands for all of these things. There are also | |
21 | commands for @dfn{filling}, which means rearranging the lines of a | |
22 | paragraph to be approximately equal in length. The commands for moving | |
23 | over and killing words, sentences and paragraphs, while intended | |
24 | primarily for editing text, are also often useful for editing programs. | |
25 | ||
26 | Emacs has several major modes for editing human-language text. If the | |
27 | file contains text pure and simple, use Text mode, which customizes | |
28 | Emacs in small ways for the syntactic conventions of text. Outline mode | |
29 | provides special commands for operating on text with an outline | |
30 | structure. | |
31 | @iftex | |
32 | @xref{Outline Mode}. | |
33 | @end iftex | |
34 | ||
35 | For text which contains embedded commands for text formatters, Emacs | |
36 | has other major modes, each for a particular text formatter. Thus, for | |
37 | input to @TeX{}, you would use @TeX{} | |
38 | @iftex | |
39 | mode (@pxref{TeX Mode}). | |
40 | @end iftex | |
41 | @ifinfo | |
42 | mode. | |
43 | @end ifinfo | |
44 | For input to nroff, use Nroff mode. | |
45 | ||
46 | Instead of using a text formatter, you can edit formatted text in | |
47 | WYSIWYG style (``what you see is what you get''), with Enriched mode. | |
48 | Then the formatting appears on the screen in Emacs while you edit. | |
49 | @iftex | |
50 | @xref{Formatted Text}. | |
51 | @end iftex | |
52 | ||
2e6d3a80 | 53 | The ``automatic typing'' features may be useful when writing text. |
dbab15b9 DL |
54 | @xref{Top, Autotyping, autotype, Features for Automatic Typing}. |
55 | ||
6bf7aab6 DL |
56 | @menu |
57 | * Words:: Moving over and killing words. | |
58 | * Sentences:: Moving over and killing sentences. | |
59 | * Paragraphs:: Moving over paragraphs. | |
60 | * Pages:: Moving over pages. | |
61 | * Filling:: Filling or justifying text. | |
62 | * Case:: Changing the case of text. | |
63 | * Text Mode:: The major modes for editing text files. | |
64 | * Outline Mode:: Editing outlines. | |
65 | * TeX Mode:: Editing input to the formatter TeX. | |
66 | * Nroff Mode:: Editing input to the formatter nroff. | |
67 | * Formatted Text:: Editing formatted text directly in WYSIWYG fashion. | |
68 | @end menu | |
69 | ||
70 | @node Words | |
71 | @section Words | |
72 | @cindex words | |
73 | @cindex Meta commands and words | |
74 | ||
75 | Emacs has commands for moving over or operating on words. By convention, | |
76 | the keys for them are all Meta characters. | |
77 | ||
78 | @c widecommands | |
79 | @table @kbd | |
80 | @item M-f | |
81 | Move forward over a word (@code{forward-word}). | |
82 | @item M-b | |
83 | Move backward over a word (@code{backward-word}). | |
84 | @item M-d | |
85 | Kill up to the end of a word (@code{kill-word}). | |
86 | @item M-@key{DEL} | |
87 | Kill back to the beginning of a word (@code{backward-kill-word}). | |
88 | @item M-@@ | |
89 | Mark the end of the next word (@code{mark-word}). | |
90 | @item M-t | |
91 | Transpose two words or drag a word across other words | |
92 | (@code{transpose-words}). | |
93 | @end table | |
94 | ||
95 | Notice how these keys form a series that parallels the character-based | |
96 | @kbd{C-f}, @kbd{C-b}, @kbd{C-d}, @key{DEL} and @kbd{C-t}. @kbd{M-@@} is | |
97 | cognate to @kbd{C-@@}, which is an alias for @kbd{C-@key{SPC}}. | |
98 | ||
99 | @kindex M-f | |
100 | @kindex M-b | |
101 | @findex forward-word | |
102 | @findex backward-word | |
103 | The commands @kbd{M-f} (@code{forward-word}) and @kbd{M-b} | |
104 | (@code{backward-word}) move forward and backward over words. These | |
105 | Meta characters are thus analogous to the corresponding control | |
106 | characters, @kbd{C-f} and @kbd{C-b}, which move over single characters | |
107 | in the text. The analogy extends to numeric arguments, which serve as | |
108 | repeat counts. @kbd{M-f} with a negative argument moves backward, and | |
109 | @kbd{M-b} with a negative argument moves forward. Forward motion | |
110 | stops right after the last letter of the word, while backward motion | |
111 | stops right before the first letter.@refill | |
112 | ||
113 | @kindex M-d | |
114 | @findex kill-word | |
115 | @kbd{M-d} (@code{kill-word}) kills the word after point. To be | |
116 | precise, it kills everything from point to the place @kbd{M-f} would | |
117 | move to. Thus, if point is in the middle of a word, @kbd{M-d} kills | |
118 | just the part after point. If some punctuation comes between point and the | |
119 | next word, it is killed along with the word. (If you wish to kill only the | |
120 | next word but not the punctuation before it, simply do @kbd{M-f} to get | |
121 | the end, and kill the word backwards with @kbd{M-@key{DEL}}.) | |
122 | @kbd{M-d} takes arguments just like @kbd{M-f}. | |
123 | ||
124 | @findex backward-kill-word | |
125 | @kindex M-DEL | |
126 | @kbd{M-@key{DEL}} (@code{backward-kill-word}) kills the word before | |
127 | point. It kills everything from point back to where @kbd{M-b} would | |
128 | move to. If point is after the space in @w{@samp{FOO, BAR}}, then | |
129 | @w{@samp{FOO, }} is killed. (If you wish to kill just @samp{FOO}, and | |
130 | not the comma and the space, use @kbd{M-b M-d} instead of | |
131 | @kbd{M-@key{DEL}}.) | |
132 | ||
4946337d EZ |
133 | @c Don't index M-t and transpose-words here, they are indexed in |
134 | @c fixit.texi, in the node "Transpose". | |
135 | @c @kindex M-t | |
136 | @c @findex transpose-words | |
6bf7aab6 DL |
137 | @kbd{M-t} (@code{transpose-words}) exchanges the word before or |
138 | containing point with the following word. The delimiter characters between | |
139 | the words do not move. For example, @w{@samp{FOO, BAR}} transposes into | |
140 | @w{@samp{BAR, FOO}} rather than @samp{@w{BAR FOO,}}. @xref{Transpose}, for | |
141 | more on transposition and on arguments to transposition commands. | |
142 | ||
143 | @kindex M-@@ | |
144 | @findex mark-word | |
145 | To operate on the next @var{n} words with an operation which applies | |
146 | between point and mark, you can either set the mark at point and then move | |
147 | over the words, or you can use the command @kbd{M-@@} (@code{mark-word}) | |
148 | which does not move point, but sets the mark where @kbd{M-f} would move | |
149 | to. @kbd{M-@@} accepts a numeric argument that says how many words to | |
150 | scan for the place to put the mark. In Transient Mark mode, this command | |
151 | activates the mark. | |
152 | ||
153 | The word commands' understanding of syntax is completely controlled by | |
154 | the syntax table. Any character can, for example, be declared to be a word | |
155 | delimiter. @xref{Syntax}. | |
156 | ||
157 | @node Sentences | |
158 | @section Sentences | |
159 | @cindex sentences | |
160 | @cindex manipulating sentences | |
161 | ||
162 | The Emacs commands for manipulating sentences and paragraphs are mostly | |
163 | on Meta keys, so as to be like the word-handling commands. | |
164 | ||
165 | @table @kbd | |
166 | @item M-a | |
167 | Move back to the beginning of the sentence (@code{backward-sentence}). | |
168 | @item M-e | |
169 | Move forward to the end of the sentence (@code{forward-sentence}). | |
170 | @item M-k | |
171 | Kill forward to the end of the sentence (@code{kill-sentence}). | |
172 | @item C-x @key{DEL} | |
173 | Kill back to the beginning of the sentence (@code{backward-kill-sentence}). | |
174 | @end table | |
175 | ||
176 | @kindex M-a | |
177 | @kindex M-e | |
178 | @findex backward-sentence | |
179 | @findex forward-sentence | |
180 | The commands @kbd{M-a} and @kbd{M-e} (@code{backward-sentence} and | |
181 | @code{forward-sentence}) move to the beginning and end of the current | |
182 | sentence, respectively. They were chosen to resemble @kbd{C-a} and | |
183 | @kbd{C-e}, which move to the beginning and end of a line. Unlike them, | |
184 | @kbd{M-a} and @kbd{M-e} if repeated or given numeric arguments move over | |
185 | successive sentences. | |
186 | ||
187 | Moving backward over a sentence places point just before the first | |
188 | character of the sentence; moving forward places point right after the | |
189 | punctuation that ends the sentence. Neither one moves over the | |
190 | whitespace at the sentence boundary. | |
191 | ||
192 | @kindex M-k | |
193 | @kindex C-x DEL | |
194 | @findex kill-sentence | |
195 | @findex backward-kill-sentence | |
196 | Just as @kbd{C-a} and @kbd{C-e} have a kill command, @kbd{C-k}, to go | |
197 | with them, so @kbd{M-a} and @kbd{M-e} have a corresponding kill command | |
198 | @kbd{M-k} (@code{kill-sentence}) which kills from point to the end of | |
199 | the sentence. With minus one as an argument it kills back to the | |
200 | beginning of the sentence. Larger arguments serve as a repeat count. | |
201 | There is also a command, @kbd{C-x @key{DEL}} | |
202 | (@code{backward-kill-sentence}), for killing back to the beginning of a | |
203 | sentence. This command is useful when you change your mind in the | |
204 | middle of composing text.@refill | |
205 | ||
206 | The sentence commands assume that you follow the American typist's | |
207 | convention of putting two spaces at the end of a sentence; they consider | |
208 | a sentence to end wherever there is a @samp{.}, @samp{?} or @samp{!} | |
209 | followed by the end of a line or two spaces, with any number of | |
210 | @samp{)}, @samp{]}, @samp{'}, or @samp{"} characters allowed in between. | |
211 | A sentence also begins or ends wherever a paragraph begins or ends. | |
212 | ||
213 | @vindex sentence-end | |
214 | The variable @code{sentence-end} controls recognition of the end of a | |
215 | sentence. It is a regexp that matches the last few characters of a | |
216 | sentence, together with the whitespace following the sentence. Its | |
217 | normal value is | |
218 | ||
219 | @example | |
220 | "[.?!][]\"')]*\\($\\|\t\\| \\)[ \t\n]*" | |
221 | @end example | |
222 | ||
223 | @noindent | |
224 | This example is explained in the section on regexps. @xref{Regexps}. | |
225 | ||
226 | If you want to use just one space between sentences, you should | |
227 | set @code{sentence-end} to this value: | |
228 | ||
229 | @example | |
230 | "[.?!][]\"')]*\\($\\|\t\\| \\)[ \t\n]*" | |
231 | @end example | |
232 | ||
233 | @noindent | |
234 | You should also set the variable @code{sentence-end-double-space} to | |
235 | @code{nil} so that the fill commands expect and leave just one space at | |
236 | the end of a sentence. Note that this makes it impossible to | |
237 | distinguish between periods that end sentences and those that indicate | |
238 | abbreviations. | |
239 | ||
240 | @node Paragraphs | |
241 | @section Paragraphs | |
242 | @cindex paragraphs | |
243 | @cindex manipulating paragraphs | |
244 | @kindex M-@{ | |
245 | @kindex M-@} | |
246 | @findex backward-paragraph | |
247 | @findex forward-paragraph | |
248 | ||
249 | The Emacs commands for manipulating paragraphs are also Meta keys. | |
250 | ||
251 | @table @kbd | |
252 | @item M-@{ | |
253 | Move back to previous paragraph beginning (@code{backward-paragraph}). | |
254 | @item M-@} | |
255 | Move forward to next paragraph end (@code{forward-paragraph}). | |
256 | @item M-h | |
257 | Put point and mark around this or next paragraph (@code{mark-paragraph}). | |
258 | @end table | |
259 | ||
260 | @kbd{M-@{} moves to the beginning of the current or previous | |
261 | paragraph, while @kbd{M-@}} moves to the end of the current or next | |
262 | paragraph. Blank lines and text-formatter command lines separate | |
263 | paragraphs and are not considered part of any paragraph. In Fundamental | |
264 | mode, but not in Text mode, an indented line also starts a new | |
265 | paragraph. (If a paragraph is preceded by a blank line, these commands | |
266 | treat that blank line as the beginning of the paragraph.) | |
267 | ||
268 | In major modes for programs, paragraphs begin and end only at blank | |
269 | lines. This makes the paragraph commands continue to be useful even | |
270 | though there are no paragraphs per se. | |
271 | ||
272 | When there is a fill prefix, then paragraphs are delimited by all lines | |
273 | which don't start with the fill prefix. @xref{Filling}. | |
274 | ||
275 | @kindex M-h | |
276 | @findex mark-paragraph | |
277 | When you wish to operate on a paragraph, you can use the command | |
278 | @kbd{M-h} (@code{mark-paragraph}) to set the region around it. Thus, | |
279 | for example, @kbd{M-h C-w} kills the paragraph around or after point. | |
280 | The @kbd{M-h} command puts point at the beginning and mark at the end of | |
281 | the paragraph point was in. In Transient Mark mode, it activates the | |
282 | mark. If point is between paragraphs (in a run of blank lines, or at a | |
283 | boundary), the paragraph following point is surrounded by point and | |
284 | mark. If there are blank lines preceding the first line of the | |
285 | paragraph, one of these blank lines is included in the region. | |
286 | ||
287 | @vindex paragraph-start | |
288 | @vindex paragraph-separate | |
289 | The precise definition of a paragraph boundary is controlled by the | |
290 | variables @code{paragraph-separate} and @code{paragraph-start}. The | |
291 | value of @code{paragraph-start} is a regexp that should match any line | |
292 | that either starts or separates paragraphs. The value of | |
293 | @code{paragraph-separate} is another regexp that should match only lines | |
294 | that separate paragraphs without being part of any paragraph (for | |
295 | example, blank lines). Lines that start a new paragraph and are | |
296 | contained in it must match only @code{paragraph-start}, not | |
297 | @code{paragraph-separate}. For example, in Fundamental mode, | |
298 | @code{paragraph-start} is @code{"[ @t{\}t@t{\}n@t{\}f]"} and | |
299 | @code{paragraph-separate} is @code{"[ @t{\}t@t{\}f]*$"}.@refill | |
300 | ||
301 | Normally it is desirable for page boundaries to separate paragraphs. | |
302 | The default values of these variables recognize the usual separator for | |
303 | pages. | |
304 | ||
305 | @node Pages | |
306 | @section Pages | |
307 | ||
308 | @cindex pages | |
309 | @cindex formfeed | |
310 | Files are often thought of as divided into @dfn{pages} by the | |
311 | @dfn{formfeed} character (ASCII control-L, octal code 014). When you | |
312 | print hardcopy for a file, this character forces a page break; thus, | |
313 | each page of the file goes on a separate page on paper. Most Emacs | |
314 | commands treat the page-separator character just like any other | |
315 | character: you can insert it with @kbd{C-q C-l}, and delete it with | |
316 | @key{DEL}. Thus, you are free to paginate your file or not. However, | |
317 | since pages are often meaningful divisions of the file, Emacs provides | |
318 | commands to move over them and operate on them. | |
319 | ||
320 | @c WideCommands | |
321 | @table @kbd | |
322 | @item C-x [ | |
323 | Move point to previous page boundary (@code{backward-page}). | |
324 | @item C-x ] | |
325 | Move point to next page boundary (@code{forward-page}). | |
326 | @item C-x C-p | |
327 | Put point and mark around this page (or another page) (@code{mark-page}). | |
328 | @item C-x l | |
329 | Count the lines in this page (@code{count-lines-page}). | |
330 | @end table | |
331 | ||
332 | @kindex C-x [ | |
333 | @kindex C-x ] | |
334 | @findex forward-page | |
335 | @findex backward-page | |
336 | The @kbd{C-x [} (@code{backward-page}) command moves point to immediately | |
337 | after the previous page delimiter. If point is already right after a page | |
338 | delimiter, it skips that one and stops at the previous one. A numeric | |
339 | argument serves as a repeat count. The @kbd{C-x ]} (@code{forward-page}) | |
340 | command moves forward past the next page delimiter. | |
341 | ||
342 | @kindex C-x C-p | |
343 | @findex mark-page | |
344 | The @kbd{C-x C-p} command (@code{mark-page}) puts point at the | |
345 | beginning of the current page and the mark at the end. The page | |
346 | delimiter at the end is included (the mark follows it). The page | |
347 | delimiter at the front is excluded (point follows it). @kbd{C-x C-p | |
348 | C-w} is a handy way to kill a page to move it elsewhere. If you move to | |
349 | another page delimiter with @kbd{C-x [} and @kbd{C-x ]}, then yank the | |
350 | killed page, all the pages will be properly delimited once again. The | |
351 | reason @kbd{C-x C-p} includes only the following page delimiter in the | |
352 | region is to ensure that. | |
353 | ||
354 | A numeric argument to @kbd{C-x C-p} is used to specify which page to go | |
355 | to, relative to the current one. Zero means the current page. One means | |
356 | the next page, and @minus{}1 means the previous one. | |
357 | ||
358 | @kindex C-x l | |
359 | @findex count-lines-page | |
360 | The @kbd{C-x l} command (@code{count-lines-page}) is good for deciding | |
361 | where to break a page in two. It prints in the echo area the total number | |
362 | of lines in the current page, and then divides it up into those preceding | |
363 | the current line and those following, as in | |
364 | ||
365 | @example | |
366 | Page has 96 (72+25) lines | |
367 | @end example | |
368 | ||
369 | @noindent | |
370 | Notice that the sum is off by one; this is correct if point is not at the | |
371 | beginning of a line. | |
372 | ||
373 | @vindex page-delimiter | |
374 | The variable @code{page-delimiter} controls where pages begin. Its | |
375 | value is a regexp that matches the beginning of a line that separates | |
376 | pages. The normal value of this variable is @code{"^@t{\}f"}, which | |
377 | matches a formfeed character at the beginning of a line. | |
378 | ||
379 | @node Filling | |
380 | @section Filling Text | |
381 | @cindex filling text | |
382 | ||
383 | @dfn{Filling} text means breaking it up into lines that fit a | |
384 | specified width. Emacs does filling in two ways. In Auto Fill mode, | |
385 | inserting text with self-inserting characters also automatically fills | |
386 | it. There are also explicit fill commands that you can use when editing | |
387 | text leaves it unfilled. When you edit formatted text, you can specify | |
388 | a style of filling for each portion of the text (@pxref{Formatted | |
389 | Text}). | |
390 | ||
391 | @menu | |
392 | * Auto Fill:: Auto Fill mode breaks long lines automatically. | |
2e6d3a80 | 393 | * Refill:: Keeping paragraphs filled. |
6bf7aab6 DL |
394 | * Fill Commands:: Commands to refill paragraphs and center lines. |
395 | * Fill Prefix:: Filling paragraphs that are indented | |
396 | or in a comment, etc. | |
397 | * Adaptive Fill:: How Emacs can determine the fill prefix automatically. | |
398 | @end menu | |
399 | ||
400 | @node Auto Fill | |
401 | @subsection Auto Fill Mode | |
402 | @cindex Auto Fill mode | |
403 | @cindex mode, Auto Fill | |
404 | @cindex word wrap | |
405 | ||
406 | @dfn{Auto Fill} mode is a minor mode in which lines are broken | |
407 | automatically when they become too wide. Breaking happens only when | |
408 | you type a @key{SPC} or @key{RET}. | |
409 | ||
410 | @table @kbd | |
411 | @item M-x auto-fill-mode | |
412 | Enable or disable Auto Fill mode. | |
413 | @item @key{SPC} | |
414 | @itemx @key{RET} | |
415 | In Auto Fill mode, break lines when appropriate. | |
416 | @end table | |
417 | ||
418 | @findex auto-fill-mode | |
419 | @kbd{M-x auto-fill-mode} turns Auto Fill mode on if it was off, or off | |
420 | if it was on. With a positive numeric argument it always turns Auto | |
421 | Fill mode on, and with a negative argument always turns it off. You can | |
422 | see when Auto Fill mode is in effect by the presence of the word | |
423 | @samp{Fill} in the mode line, inside the parentheses. Auto Fill mode is | |
424 | a minor mode which is enabled or disabled for each buffer individually. | |
425 | @xref{Minor Modes}. | |
426 | ||
427 | In Auto Fill mode, lines are broken automatically at spaces when they | |
428 | get longer than the desired width. Line breaking and rearrangement | |
429 | takes place only when you type @key{SPC} or @key{RET}. If you wish to | |
430 | insert a space or newline without permitting line-breaking, type | |
431 | @kbd{C-q @key{SPC}} or @kbd{C-q C-j} (recall that a newline is really a | |
432 | control-J). Also, @kbd{C-o} inserts a newline without line breaking. | |
433 | ||
434 | Auto Fill mode works well with programming-language modes, because it | |
435 | indents new lines with @key{TAB}. If a line ending in a comment gets | |
436 | too long, the text of the comment is split into two comment lines. | |
437 | Optionally, new comment delimiters are inserted at the end of the first | |
438 | line and the beginning of the second so that each line is a separate | |
439 | comment; the variable @code{comment-multi-line} controls the choice | |
440 | (@pxref{Comments}). | |
441 | ||
442 | Adaptive filling (see the following section) works for Auto Filling as | |
443 | well as for explicit fill commands. It takes a fill prefix | |
444 | automatically from the second or first line of a paragraph. | |
445 | ||
446 | Auto Fill mode does not refill entire paragraphs; it can break lines but | |
447 | cannot merge lines. So editing in the middle of a paragraph can result in | |
448 | a paragraph that is not correctly filled. The easiest way to make the | |
449 | paragraph properly filled again is usually with the explicit fill commands. | |
450 | @ifinfo | |
451 | @xref{Fill Commands}. | |
452 | @end ifinfo | |
453 | ||
454 | Many users like Auto Fill mode and want to use it in all text files. | |
455 | The section on init files says how to arrange this permanently for yourself. | |
456 | @xref{Init File}. | |
457 | ||
2e6d3a80 RS |
458 | @node Refill |
459 | @subsection Refill Mode | |
460 | @cindex refilling text, word processor style | |
461 | @cindex modes, Refill | |
462 | @cindex Refill minor mode | |
463 | ||
464 | Refill minor mode provides support for keeping paragraphs filled as | |
465 | you type or modify them in other ways. It provides an effect similar | |
466 | to typical word processor behaviour. This works by running a | |
467 | paragraph-filling command at suitable times. | |
468 | ||
469 | When you are typing text, only characters which normally trigger | |
470 | auto filling, like the space character, will trigger refilling. This | |
471 | is to avoid making it too slow. Apart from self-inserting characters, | |
472 | other commands which modify the text cause refilling. | |
473 | ||
474 | The current implementation is preliminary and probably not robust. | |
475 | We expect to improve on it. | |
476 | ||
6bf7aab6 DL |
477 | @node Fill Commands |
478 | @subsection Explicit Fill Commands | |
479 | ||
480 | @table @kbd | |
481 | @item M-q | |
482 | Fill current paragraph (@code{fill-paragraph}). | |
483 | @item C-x f | |
484 | Set the fill column (@code{set-fill-column}). | |
485 | @item M-x fill-region | |
486 | Fill each paragraph in the region (@code{fill-region}). | |
487 | @item M-x fill-region-as-paragraph | |
488 | Fill the region, considering it as one paragraph. | |
489 | @item M-s | |
490 | Center a line. | |
491 | @end table | |
492 | ||
493 | @kindex M-q | |
494 | @findex fill-paragraph | |
495 | To refill a paragraph, use the command @kbd{M-q} | |
496 | (@code{fill-paragraph}). This operates on the paragraph that point is | |
497 | inside, or the one after point if point is between paragraphs. | |
498 | Refilling works by removing all the line-breaks, then inserting new ones | |
499 | where necessary. | |
500 | ||
501 | @findex fill-region | |
502 | To refill many paragraphs, use @kbd{M-x fill-region}, which | |
503 | divides the region into paragraphs and fills each of them. | |
504 | ||
505 | @findex fill-region-as-paragraph | |
506 | @kbd{M-q} and @code{fill-region} use the same criteria as @kbd{M-h} | |
507 | for finding paragraph boundaries (@pxref{Paragraphs}). For more | |
508 | control, you can use @kbd{M-x fill-region-as-paragraph}, which refills | |
509 | everything between point and mark. This command deletes any blank lines | |
510 | within the region, so separate blocks of text end up combined into one | |
511 | block.@refill | |
512 | ||
513 | @cindex justification | |
514 | A numeric argument to @kbd{M-q} causes it to @dfn{justify} the text as | |
515 | well as filling it. This means that extra spaces are inserted to make | |
516 | the right margin line up exactly at the fill column. To remove the | |
517 | extra spaces, use @kbd{M-q} with no argument. (Likewise for | |
518 | @code{fill-region}.) Another way to control justification, and choose | |
519 | other styles of filling, is with the @code{justification} text property; | |
520 | see @ref{Format Justification}. | |
521 | ||
522 | @kindex M-s @r{(Text mode)} | |
523 | @cindex centering | |
524 | @findex center-line | |
525 | The command @kbd{M-s} (@code{center-line}) centers the current line | |
526 | within the current fill column. With an argument @var{n}, it centers | |
527 | @var{n} lines individually and moves past them. | |
528 | ||
529 | @vindex fill-column | |
530 | @kindex C-x f | |
531 | @findex set-fill-column | |
532 | The maximum line width for filling is in the variable | |
533 | @code{fill-column}. Altering the value of @code{fill-column} makes it | |
534 | local to the current buffer; until that time, the default value is in | |
535 | effect. The default is initially 70. @xref{Locals}. The easiest way | |
536 | to set @code{fill-column} is to use the command @kbd{C-x f} | |
537 | (@code{set-fill-column}). With a numeric argument, it uses that as the | |
538 | new fill column. With just @kbd{C-u} as argument, it sets | |
539 | @code{fill-column} to the current horizontal position of point. | |
540 | ||
541 | Emacs commands normally consider a period followed by two spaces or by | |
542 | a newline as the end of a sentence; a period followed by just one space | |
543 | indicates an abbreviation and not the end of a sentence. To preserve | |
544 | the distinction between these two ways of using a period, the fill | |
545 | commands do not break a line after a period followed by just one space. | |
546 | ||
547 | @vindex sentence-end-double-space | |
548 | If the variable @code{sentence-end-double-space} is @code{nil}, the | |
549 | fill commands expect and leave just one space at the end of a sentence. | |
550 | Ordinarily this variable is @code{t}, so the fill commands insist on | |
551 | two spaces for the end of a sentence, as explained above. @xref{Sentences}. | |
552 | ||
553 | @vindex colon-double-space | |
554 | If the variable @code{colon-double-space} is non-@code{nil}, the | |
555 | fill commands put two spaces after a colon. | |
556 | ||
a3de91cd | 557 | @vindex sentence-end-without-period |
2e6d3a80 RS |
558 | Some languages do not use period to indicate end of sentence. For |
559 | example, a sentence in Thai text ends with double space but without a | |
560 | period. Set the variable @code{sentence-end-without-period} to | |
561 | @code{t} to tell the sentence commands that a period is not necessary. | |
a3de91cd | 562 | |
6bf7aab6 DL |
563 | @node Fill Prefix |
564 | @subsection The Fill Prefix | |
565 | ||
566 | @cindex fill prefix | |
567 | To fill a paragraph in which each line starts with a special marker | |
568 | (which might be a few spaces, giving an indented paragraph), you can use | |
569 | the @dfn{fill prefix} feature. The fill prefix is a string that Emacs | |
570 | expects every line to start with, and which is not included in filling. | |
571 | You can specify a fill prefix explicitly; Emacs can also deduce the | |
572 | fill prefix automatically (@pxref{Adaptive Fill}). | |
573 | ||
574 | @table @kbd | |
575 | @item C-x . | |
576 | Set the fill prefix (@code{set-fill-prefix}). | |
577 | @item M-q | |
578 | Fill a paragraph using current fill prefix (@code{fill-paragraph}). | |
579 | @item M-x fill-individual-paragraphs | |
580 | Fill the region, considering each change of indentation as starting a | |
581 | new paragraph. | |
582 | @item M-x fill-nonuniform-paragraphs | |
583 | Fill the region, considering only paragraph-separator lines as starting | |
584 | a new paragraph. | |
585 | @end table | |
586 | ||
587 | @kindex C-x . | |
588 | @findex set-fill-prefix | |
589 | To specify a fill prefix, move to a line that starts with the desired | |
590 | prefix, put point at the end of the prefix, and give the command | |
591 | @w{@kbd{C-x .}}@: (@code{set-fill-prefix}). That's a period after the | |
592 | @kbd{C-x}. To turn off the fill prefix, specify an empty prefix: type | |
593 | @w{@kbd{C-x .}}@: with point at the beginning of a line.@refill | |
594 | ||
595 | When a fill prefix is in effect, the fill commands remove the fill | |
596 | prefix from each line before filling and insert it on each line after | |
597 | filling. Auto Fill mode also inserts the fill prefix automatically when | |
598 | it makes a new line. The @kbd{C-o} command inserts the fill prefix on | |
599 | new lines it creates, when you use it at the beginning of a line | |
600 | (@pxref{Blank Lines}). Conversely, the command @kbd{M-^} deletes the | |
601 | prefix (if it occurs) after the newline that it deletes | |
602 | (@pxref{Indentation}). | |
603 | ||
604 | For example, if @code{fill-column} is 40 and you set the fill prefix | |
605 | to @samp{;; }, then @kbd{M-q} in the following text | |
606 | ||
607 | @example | |
608 | ;; This is an | |
609 | ;; example of a paragraph | |
610 | ;; inside a Lisp-style comment. | |
611 | @end example | |
612 | ||
613 | @noindent | |
614 | produces this: | |
615 | ||
616 | @example | |
617 | ;; This is an example of a paragraph | |
618 | ;; inside a Lisp-style comment. | |
619 | @end example | |
620 | ||
621 | Lines that do not start with the fill prefix are considered to start | |
622 | paragraphs, both in @kbd{M-q} and the paragraph commands; this gives | |
623 | good results for paragraphs with hanging indentation (every line | |
624 | indented except the first one). Lines which are blank or indented once | |
625 | the prefix is removed also separate or start paragraphs; this is what | |
626 | you want if you are writing multi-paragraph comments with a comment | |
627 | delimiter on each line. | |
628 | ||
629 | @findex fill-individual-paragraphs | |
630 | You can use @kbd{M-x fill-individual-paragraphs} to set the fill | |
631 | prefix for each paragraph automatically. This command divides the | |
632 | region into paragraphs, treating every change in the amount of | |
633 | indentation as the start of a new paragraph, and fills each of these | |
634 | paragraphs. Thus, all the lines in one ``paragraph'' have the same | |
635 | amount of indentation. That indentation serves as the fill prefix for | |
636 | that paragraph. | |
637 | ||
638 | @findex fill-nonuniform-paragraphs | |
639 | @kbd{M-x fill-nonuniform-paragraphs} is a similar command that divides | |
640 | the region into paragraphs in a different way. It considers only | |
641 | paragraph-separating lines (as defined by @code{paragraph-separate}) as | |
642 | starting a new paragraph. Since this means that the lines of one | |
643 | paragraph may have different amounts of indentation, the fill prefix | |
644 | used is the smallest amount of indentation of any of the lines of the | |
645 | paragraph. This gives good results with styles that indent a paragraph's | |
646 | first line more or less that the rest of the paragraph. | |
647 | ||
648 | @vindex fill-prefix | |
649 | The fill prefix is stored in the variable @code{fill-prefix}. Its value | |
650 | is a string, or @code{nil} when there is no fill prefix. This is a | |
651 | per-buffer variable; altering the variable affects only the current buffer, | |
652 | but there is a default value which you can change as well. @xref{Locals}. | |
653 | ||
654 | The @code{indentation} text property provides another way to control | |
655 | the amount of indentation paragraphs receive. @xref{Format Indentation}. | |
656 | ||
657 | @node Adaptive Fill | |
658 | @subsection Adaptive Filling | |
659 | ||
660 | @cindex adaptive filling | |
661 | The fill commands can deduce the proper fill prefix for a paragraph | |
662 | automatically in certain cases: either whitespace or certain punctuation | |
663 | characters at the beginning of a line are propagated to all lines of the | |
664 | paragraph. | |
665 | ||
666 | If the paragraph has two or more lines, the fill prefix is taken from | |
667 | the paragraph's second line, but only if it appears on the first line as | |
668 | well. | |
669 | ||
670 | If a paragraph has just one line, fill commands @emph{may} take a | |
671 | prefix from that line. The decision is complicated because there are | |
672 | three reasonable things to do in such a case: | |
673 | ||
674 | @itemize @bullet | |
675 | @item | |
676 | Use the first line's prefix on all the lines of the paragraph. | |
677 | ||
678 | @item | |
679 | Indent subsequent lines with whitespace, so that they line up under the | |
680 | text that follows the prefix on the first line, but don't actually copy | |
681 | the prefix from the first line. | |
682 | ||
683 | @item | |
684 | Don't do anything special with the second and following lines. | |
685 | @end itemize | |
686 | ||
687 | All three of these styles of formatting are commonly used. So the | |
688 | fill commands try to determine what you would like, based on the prefix | |
689 | that appears and on the major mode. Here is how. | |
690 | ||
691 | @vindex adaptive-fill-first-line-regexp | |
692 | If the prefix found on the first line matches | |
693 | @code{adaptive-fill-first-line-regexp}, or if it appears to be a | |
694 | comment-starting sequence (this depends on the major mode), then the | |
695 | prefix found is used for filling the paragraph, provided it would not | |
696 | act as a paragraph starter on subsequent lines. | |
697 | ||
698 | Otherwise, the prefix found is converted to an equivalent number of | |
699 | spaces, and those spaces are used as the fill prefix for the rest of the | |
700 | lines, provided they would not act as a paragraph starter on subsequent | |
701 | lines. | |
702 | ||
703 | In Text mode, and other modes where only blank lines and page | |
704 | delimiters separate paragraphs, the prefix chosen by adaptive filling | |
705 | never acts as a paragraph starter, so it can always be used for filling. | |
706 | ||
707 | @vindex adaptive-fill-mode | |
708 | @vindex adaptive-fill-regexp | |
709 | The variable @code{adaptive-fill-regexp} determines what kinds of line | |
710 | beginnings can serve as a fill prefix: any characters at the start of | |
711 | the line that match this regular expression are used. If you set the | |
712 | variable @code{adaptive-fill-mode} to @code{nil}, the fill prefix is | |
713 | never chosen automatically. | |
714 | ||
715 | @vindex adaptive-fill-function | |
716 | You can specify more complex ways of choosing a fill prefix | |
717 | automatically by setting the variable @code{adaptive-fill-function} to a | |
718 | function. This function is called with point after the left margin of a | |
719 | line, and it should return the appropriate fill prefix based on that | |
720 | line. If it returns @code{nil}, that means it sees no fill prefix in | |
721 | that line. | |
722 | ||
723 | @node Case | |
724 | @section Case Conversion Commands | |
725 | @cindex case conversion | |
726 | ||
727 | Emacs has commands for converting either a single word or any arbitrary | |
728 | range of text to upper case or to lower case. | |
729 | ||
730 | @c WideCommands | |
731 | @table @kbd | |
732 | @item M-l | |
733 | Convert following word to lower case (@code{downcase-word}). | |
734 | @item M-u | |
735 | Convert following word to upper case (@code{upcase-word}). | |
736 | @item M-c | |
737 | Capitalize the following word (@code{capitalize-word}). | |
738 | @item C-x C-l | |
739 | Convert region to lower case (@code{downcase-region}). | |
740 | @item C-x C-u | |
741 | Convert region to upper case (@code{upcase-region}). | |
742 | @end table | |
743 | ||
744 | @kindex M-l | |
745 | @kindex M-u | |
746 | @kindex M-c | |
747 | @cindex words, case conversion | |
748 | @cindex converting text to upper or lower case | |
749 | @cindex capitalizing words | |
750 | @findex downcase-word | |
751 | @findex upcase-word | |
752 | @findex capitalize-word | |
753 | The word conversion commands are the most useful. @kbd{M-l} | |
754 | (@code{downcase-word}) converts the word after point to lower case, moving | |
755 | past it. Thus, repeating @kbd{M-l} converts successive words. | |
756 | @kbd{M-u} (@code{upcase-word}) converts to all capitals instead, while | |
757 | @kbd{M-c} (@code{capitalize-word}) puts the first letter of the word | |
758 | into upper case and the rest into lower case. All these commands convert | |
759 | several words at once if given an argument. They are especially convenient | |
760 | for converting a large amount of text from all upper case to mixed case, | |
761 | because you can move through the text using @kbd{M-l}, @kbd{M-u} or | |
762 | @kbd{M-c} on each word as appropriate, occasionally using @kbd{M-f} instead | |
763 | to skip a word. | |
764 | ||
765 | When given a negative argument, the word case conversion commands apply | |
766 | to the appropriate number of words before point, but do not move point. | |
767 | This is convenient when you have just typed a word in the wrong case: you | |
768 | can give the case conversion command and continue typing. | |
769 | ||
770 | If a word case conversion command is given in the middle of a word, it | |
771 | applies only to the part of the word which follows point. This is just | |
772 | like what @kbd{M-d} (@code{kill-word}) does. With a negative argument, | |
773 | case conversion applies only to the part of the word before point. | |
774 | ||
775 | @kindex C-x C-l | |
776 | @kindex C-x C-u | |
777 | @findex downcase-region | |
778 | @findex upcase-region | |
779 | The other case conversion commands are @kbd{C-x C-u} | |
780 | (@code{upcase-region}) and @kbd{C-x C-l} (@code{downcase-region}), which | |
781 | convert everything between point and mark to the specified case. Point and | |
782 | mark do not move. | |
783 | ||
784 | The region case conversion commands @code{upcase-region} and | |
785 | @code{downcase-region} are normally disabled. This means that they ask | |
786 | for confirmation if you try to use them. When you confirm, you may | |
787 | enable the command, which means it will not ask for confirmation again. | |
788 | @xref{Disabling}. | |
789 | ||
790 | @node Text Mode | |
791 | @section Text Mode | |
792 | @cindex Text mode | |
793 | @cindex mode, Text | |
794 | @findex text-mode | |
795 | ||
796 | When you edit files of text in a human language, it's more convenient | |
797 | to use Text mode rather than Fundamental mode. To enter Text mode, type | |
798 | @kbd{M-x text-mode}. | |
799 | ||
800 | In Text mode, only blank lines and page delimiters separate | |
801 | paragraphs. As a result, paragraphs can be indented, and adaptive | |
802 | filling determines what indentation to use when filling a paragraph. | |
803 | @xref{Adaptive Fill}. | |
804 | ||
805 | @kindex TAB @r{(Text mode)} | |
806 | Text mode defines @key{TAB} to run @code{indent-relative} | |
807 | (@pxref{Indentation}), so that you can conveniently indent a line like | |
808 | the previous line. When the previous line is not indented, | |
809 | @code{indent-relative} runs @code{tab-to-tab-stop}, which uses Emacs tab | |
810 | stops that you can set (@pxref{Tab Stops}). | |
811 | ||
812 | Text mode turns off the features concerned with comments except when | |
813 | you explicitly invoke them. It changes the syntax table so that periods | |
814 | are not considered part of a word, while apostrophes, backspaces and | |
815 | underlines are considered part of words. | |
816 | ||
817 | @cindex Paragraph-Indent Text mode | |
818 | @cindex mode, Paragraph-Indent Text | |
819 | @findex paragraph-indent-text-mode | |
dbab15b9 | 820 | @findex paragraph-indent-minor-mode |
6bf7aab6 DL |
821 | If you indent the first lines of paragraphs, then you should use |
822 | Paragraph-Indent Text mode rather than Text mode. In this mode, you do | |
823 | not need to have blank lines between paragraphs, because the first-line | |
824 | indentation is sufficient to start a paragraph; however paragraphs in | |
825 | which every line is indented are not supported. Use @kbd{M-x | |
dbab15b9 DL |
826 | paragraph-indent-text-mode} to enter this mode. Use @kbd{M-x |
827 | paragraph-indent-minor-mode} to enter an equivalent minor mode, for | |
828 | instance during mail composition. | |
6bf7aab6 DL |
829 | |
830 | @kindex M-TAB @r{(Text mode)} | |
831 | Text mode, and all the modes based on it, define @kbd{M-@key{TAB}} as | |
832 | the command @code{ispell-complete-word}, which performs completion of | |
833 | the partial word in the buffer before point, using the spelling | |
834 | dictionary as the space of possible words. @xref{Spelling}. | |
835 | ||
836 | @vindex text-mode-hook | |
837 | Entering Text mode runs the hook @code{text-mode-hook}. Other major | |
838 | modes related to Text mode also run this hook, followed by hooks of | |
839 | their own; this includes Paragraph-Indent Text mode, Nroff mode, @TeX{} | |
840 | mode, Outline mode, and Mail mode. Hook functions on | |
841 | @code{text-mode-hook} can look at the value of @code{major-mode} to see | |
842 | which of these modes is actually being entered. @xref{Hooks}. | |
843 | ||
844 | @ifinfo | |
845 | Emacs provides two other modes for editing text that is to be passed | |
846 | through a text formatter to produce fancy formatted printed output. | |
847 | @xref{Nroff Mode}, for editing input to the formatter nroff. | |
848 | @xref{TeX Mode}, for editing input to the formatter TeX. | |
849 | ||
850 | Another mode is used for editing outlines. It allows you to view the | |
851 | text at various levels of detail. You can view either the outline | |
852 | headings alone or both headings and text; you can also hide some of the | |
853 | headings at lower levels from view to make the high level structure more | |
854 | visible. @xref{Outline Mode}. | |
855 | @end ifinfo | |
856 | ||
857 | @node Outline Mode | |
858 | @section Outline Mode | |
859 | @cindex Outline mode | |
860 | @cindex mode, Outline | |
6bf7aab6 DL |
861 | @cindex invisible lines |
862 | ||
863 | @findex outline-mode | |
864 | @findex outline-minor-mode | |
865 | @vindex outline-minor-mode-prefix | |
866 | Outline mode is a major mode much like Text mode but intended for | |
867 | editing outlines. It allows you to make parts of the text temporarily | |
868 | invisible so that you can see the outline structure. Type @kbd{M-x | |
869 | outline-mode} to switch to Outline mode as the major mode of the current | |
870 | buffer. | |
871 | ||
872 | When Outline mode makes a line invisible, the line does not appear on | |
873 | the screen. The screen appears exactly as if the invisible line were | |
874 | deleted, except that an ellipsis (three periods in a row) appears at the | |
875 | end of the previous visible line (only one ellipsis no matter how many | |
876 | invisible lines follow). | |
877 | ||
878 | Editing commands that operate on lines, such as @kbd{C-n} and | |
879 | @kbd{C-p}, treat the text of the invisible line as part of the previous | |
880 | visible line. Killing an entire visible line, including its terminating | |
881 | newline, really kills all the following invisible lines along with it. | |
882 | ||
883 | Outline minor mode provides the same commands as the major mode, | |
884 | Outline mode, but you can use it in conjunction with other major modes. | |
885 | Type @kbd{M-x outline-minor-mode} to enable the Outline minor mode in | |
886 | the current buffer. You can also specify this in the text of a file, | |
887 | with a file local variable of the form @samp{mode: outline-minor} | |
888 | (@pxref{File Variables}). | |
889 | ||
890 | @kindex C-c @@ @r{(Outline minor mode)} | |
891 | The major mode, Outline mode, provides special key bindings on the | |
892 | @kbd{C-c} prefix. Outline minor mode provides similar bindings with | |
893 | @kbd{C-c @@} as the prefix; this is to reduce the conflicts with the | |
894 | major mode's special commands. (The variable | |
895 | @code{outline-minor-mode-prefix} controls the prefix used.) | |
896 | ||
897 | @vindex outline-mode-hook | |
898 | Entering Outline mode runs the hook @code{text-mode-hook} followed by | |
899 | the hook @code{outline-mode-hook} (@pxref{Hooks}). | |
900 | ||
901 | @menu | |
902 | * Format: Outline Format. What the text of an outline looks like. | |
903 | * Motion: Outline Motion. Special commands for moving through | |
904 | outlines. | |
905 | * Visibility: Outline Visibility. Commands to control what is visible. | |
906 | * Views: Outline Views. Outlines and multiple views. | |
9577aa62 | 907 | * Foldout:: Folding editing. |
6bf7aab6 DL |
908 | @end menu |
909 | ||
910 | @node Outline Format | |
911 | @subsection Format of Outlines | |
912 | ||
913 | @cindex heading lines (Outline mode) | |
914 | @cindex body lines (Outline mode) | |
915 | Outline mode assumes that the lines in the buffer are of two types: | |
916 | @dfn{heading lines} and @dfn{body lines}. A heading line represents a | |
917 | topic in the outline. Heading lines start with one or more stars; the | |
918 | number of stars determines the depth of the heading in the outline | |
919 | structure. Thus, a heading line with one star is a major topic; all the | |
920 | heading lines with two stars between it and the next one-star heading | |
921 | are its subtopics; and so on. Any line that is not a heading line is a | |
922 | body line. Body lines belong with the preceding heading line. Here is | |
923 | an example: | |
924 | ||
925 | @example | |
926 | * Food | |
927 | This is the body, | |
928 | which says something about the topic of food. | |
929 | ||
930 | ** Delicious Food | |
931 | This is the body of the second-level header. | |
932 | ||
933 | ** Distasteful Food | |
934 | This could have | |
935 | a body too, with | |
936 | several lines. | |
937 | ||
938 | *** Dormitory Food | |
939 | ||
940 | * Shelter | |
941 | Another first-level topic with its header line. | |
942 | @end example | |
943 | ||
944 | A heading line together with all following body lines is called | |
945 | collectively an @dfn{entry}. A heading line together with all following | |
946 | deeper heading lines and their body lines is called a @dfn{subtree}. | |
947 | ||
948 | @vindex outline-regexp | |
949 | You can customize the criterion for distinguishing heading lines | |
950 | by setting the variable @code{outline-regexp}. Any line whose | |
951 | beginning has a match for this regexp is considered a heading line. | |
952 | Matches that start within a line (not at the left margin) do not count. | |
953 | The length of the matching text determines the level of the heading; | |
954 | longer matches make a more deeply nested level. Thus, for example, | |
955 | if a text formatter has commands @samp{@@chapter}, @samp{@@section} | |
956 | and @samp{@@subsection} to divide the document into chapters and | |
957 | sections, you could make those lines count as heading lines by | |
958 | setting @code{outline-regexp} to @samp{"@@chap\\|@@\\(sub\\)*section"}. | |
959 | Note the trick: the two words @samp{chapter} and @samp{section} are equally | |
960 | long, but by defining the regexp to match only @samp{chap} we ensure | |
961 | that the length of the text matched on a chapter heading is shorter, | |
962 | so that Outline mode will know that sections are contained in chapters. | |
963 | This works as long as no other command starts with @samp{@@chap}. | |
964 | ||
965 | @vindex outline-level | |
2e6d3a80 RS |
966 | You can change the rule for calculating the level of a heading line |
967 | by setting the variable @code{outline-level}. The value of | |
6bf7aab6 DL |
968 | @code{outline-level} should be a function that takes no arguments and |
969 | returns the level of the current heading. Some major modes such as C, | |
2e6d3a80 RS |
970 | Nroff, and Emacs Lisp mode set this variable and @code{outline-regexp} |
971 | in order to work with Outline minor mode. | |
6bf7aab6 DL |
972 | |
973 | @node Outline Motion | |
974 | @subsection Outline Motion Commands | |
975 | ||
976 | Outline mode provides special motion commands that move backward and | |
977 | forward to heading lines. | |
978 | ||
979 | @table @kbd | |
980 | @item C-c C-n | |
981 | Move point to the next visible heading line | |
982 | (@code{outline-next-visible-heading}). | |
983 | @item C-c C-p | |
984 | Move point to the previous visible heading line | |
985 | (@code{outline-previous-visible-heading}). | |
986 | @item C-c C-f | |
987 | Move point to the next visible heading line at the same level | |
988 | as the one point is on (@code{outline-forward-same-level}). | |
989 | @item C-c C-b | |
990 | Move point to the previous visible heading line at the same level | |
991 | (@code{outline-backward-same-level}). | |
992 | @item C-c C-u | |
993 | Move point up to a lower-level (more inclusive) visible heading line | |
994 | (@code{outline-up-heading}). | |
995 | @end table | |
996 | ||
997 | @findex outline-next-visible-heading | |
998 | @findex outline-previous-visible-heading | |
999 | @kindex C-c C-n @r{(Outline mode)} | |
1000 | @kindex C-c C-p @r{(Outline mode)} | |
1001 | @kbd{C-c C-n} (@code{outline-next-visible-heading}) moves down to the next | |
1002 | heading line. @kbd{C-c C-p} (@code{outline-previous-visible-heading}) moves | |
1003 | similarly backward. Both accept numeric arguments as repeat counts. The | |
1004 | names emphasize that invisible headings are skipped, but this is not really | |
1005 | a special feature. All editing commands that look for lines ignore the | |
1006 | invisible lines automatically.@refill | |
1007 | ||
1008 | @findex outline-up-heading | |
1009 | @findex outline-forward-same-level | |
1010 | @findex outline-backward-same-level | |
1011 | @kindex C-c C-f @r{(Outline mode)} | |
1012 | @kindex C-c C-b @r{(Outline mode)} | |
1013 | @kindex C-c C-u @r{(Outline mode)} | |
1014 | More powerful motion commands understand the level structure of headings. | |
1015 | @kbd{C-c C-f} (@code{outline-forward-same-level}) and | |
1016 | @kbd{C-c C-b} (@code{outline-backward-same-level}) move from one | |
1017 | heading line to another visible heading at the same depth in | |
1018 | the outline. @kbd{C-c C-u} (@code{outline-up-heading}) moves | |
1019 | backward to another heading that is less deeply nested. | |
1020 | ||
1021 | @node Outline Visibility | |
1022 | @subsection Outline Visibility Commands | |
1023 | ||
1024 | The other special commands of outline mode are used to make lines visible | |
1025 | or invisible. Their names all start with @code{hide} or @code{show}. | |
1026 | Most of them fall into pairs of opposites. They are not undoable; instead, | |
1027 | you can undo right past them. Making lines visible or invisible is simply | |
1028 | not recorded by the undo mechanism. | |
1029 | ||
1030 | @table @kbd | |
1031 | @item C-c C-t | |
1032 | Make all body lines in the buffer invisible (@code{hide-body}). | |
1033 | @item C-c C-a | |
1034 | Make all lines in the buffer visible (@code{show-all}). | |
1035 | @item C-c C-d | |
1036 | Make everything under this heading invisible, not including this | |
1037 | heading itself (@code{hide-subtree}). | |
1038 | @item C-c C-s | |
1039 | Make everything under this heading visible, including body, | |
1040 | subheadings, and their bodies (@code{show-subtree}). | |
1041 | @item C-c C-l | |
1042 | Make the body of this heading line, and of all its subheadings, | |
1043 | invisible (@code{hide-leaves}). | |
1044 | @item C-c C-k | |
1045 | Make all subheadings of this heading line, at all levels, visible | |
1046 | (@code{show-branches}). | |
1047 | @item C-c C-i | |
1048 | Make immediate subheadings (one level down) of this heading line | |
1049 | visible (@code{show-children}). | |
1050 | @item C-c C-c | |
1051 | Make this heading line's body invisible (@code{hide-entry}). | |
1052 | @item C-c C-e | |
1053 | Make this heading line's body visible (@code{show-entry}). | |
1054 | @item C-c C-q | |
1055 | Hide everything except the top @var{n} levels of heading lines | |
1056 | (@code{hide-sublevels}). | |
1057 | @item C-c C-o | |
1058 | Hide everything except for the heading or body that point is in, plus | |
1059 | the headings leading up from there to the top level of the outline | |
1060 | (@code{hide-other}). | |
1061 | @end table | |
1062 | ||
1063 | @findex hide-entry | |
1064 | @findex show-entry | |
1065 | @kindex C-c C-c @r{(Outline mode)} | |
1066 | @kindex C-c C-e @r{(Outline mode)} | |
1067 | Two commands that are exact opposites are @kbd{C-c C-c} | |
1068 | (@code{hide-entry}) and @kbd{C-c C-e} (@code{show-entry}). They are | |
1069 | used with point on a heading line, and apply only to the body lines of | |
1070 | that heading. Subheadings and their bodies are not affected. | |
1071 | ||
1072 | @findex hide-subtree | |
1073 | @findex show-subtree | |
1074 | @kindex C-c C-s @r{(Outline mode)} | |
1075 | @kindex C-c C-d @r{(Outline mode)} | |
1076 | @cindex subtree (Outline mode) | |
1077 | Two more powerful opposites are @kbd{C-c C-d} (@code{hide-subtree}) and | |
1078 | @kbd{C-c C-s} (@code{show-subtree}). Both expect to be used when point is | |
1079 | on a heading line, and both apply to all the lines of that heading's | |
1080 | @dfn{subtree}: its body, all its subheadings, both direct and indirect, and | |
1081 | all of their bodies. In other words, the subtree contains everything | |
1082 | following this heading line, up to and not including the next heading of | |
1083 | the same or higher rank.@refill | |
1084 | ||
1085 | @findex hide-leaves | |
1086 | @findex show-branches | |
1087 | @kindex C-c C-l @r{(Outline mode)} | |
1088 | @kindex C-c C-k @r{(Outline mode)} | |
1089 | Intermediate between a visible subtree and an invisible one is having | |
1090 | all the subheadings visible but none of the body. There are two | |
1091 | commands for doing this, depending on whether you want to hide the | |
1092 | bodies or make the subheadings visible. They are @kbd{C-c C-l} | |
1093 | (@code{hide-leaves}) and @kbd{C-c C-k} (@code{show-branches}). | |
1094 | ||
1095 | @kindex C-c C-i @r{(Outline mode)} | |
1096 | @findex show-children | |
1097 | A little weaker than @code{show-branches} is @kbd{C-c C-i} | |
1098 | (@code{show-children}). It makes just the direct subheadings | |
1099 | visible---those one level down. Deeper subheadings remain invisible, if | |
1100 | they were invisible.@refill | |
1101 | ||
1102 | @findex hide-body | |
1103 | @findex show-all | |
1104 | @kindex C-c C-t @r{(Outline mode)} | |
1105 | @kindex C-c C-a @r{(Outline mode)} | |
1106 | Two commands have a blanket effect on the whole file. @kbd{C-c C-t} | |
1107 | (@code{hide-body}) makes all body lines invisible, so that you see just | |
1108 | the outline structure. @kbd{C-c C-a} (@code{show-all}) makes all lines | |
1109 | visible. These commands can be thought of as a pair of opposites even | |
1110 | though @kbd{C-c C-a} applies to more than just body lines. | |
1111 | ||
1112 | @findex hide-sublevels | |
1113 | @kindex C-c C-q @r{(Outline mode)} | |
1114 | The command @kbd{C-c C-q} (@code{hide-sublevels}) hides all but the | |
1115 | top level headings. With a numeric argument @var{n}, it hides everything | |
1116 | except the top @var{n} levels of heading lines. | |
1117 | ||
1118 | @findex hide-other | |
1119 | @kindex C-c C-o @r{(Outline mode)} | |
1120 | The command @kbd{C-c C-o} (@code{hide-other}) hides everything except | |
1121 | the heading or body text that point is in, plus its parents (the headers | |
1122 | leading up from there to top level in the outline). | |
1123 | ||
1124 | You can turn off the use of ellipses at the ends of visible lines by | |
1125 | setting @code{selective-display-ellipses} to @code{nil}. Then there is | |
1126 | no visible indication of the presence of invisible lines. | |
1127 | ||
1128 | When incremental search finds text that is hidden by Outline mode, | |
1129 | it makes that part of the buffer visible. If you exit the search | |
1130 | at that position, the text remains visible. | |
1131 | ||
1132 | @node Outline Views | |
1133 | @subsection Viewing One Outline in Multiple Views | |
1134 | ||
1135 | @cindex multiple views of outline | |
1136 | @cindex views of an outline | |
1137 | @cindex outline with multiple views | |
1138 | @cindex indirect buffers and outlines | |
1139 | You can display two views of a single outline at the same time, in | |
1140 | different windows. To do this, you must create an indirect buffer using | |
1141 | @kbd{M-x make-indirect-buffer}. The first argument of this command is | |
1142 | the existing outline buffer name, and its second argument is the name to | |
1143 | use for the new indirect buffer. @xref{Indirect Buffers}. | |
1144 | ||
1145 | Once the indirect buffer exists, you can display it in a window in the | |
1146 | normal fashion, with @kbd{C-x 4 b} or other Emacs commands. The Outline | |
1147 | mode commands to show and hide parts of the text operate on each buffer | |
1148 | independently; as a result, each buffer can have its own view. If you | |
1149 | want more than two views on the same outline, create additional indirect | |
1150 | buffers. | |
1151 | ||
9577aa62 | 1152 | @node Foldout |
2e6d3a80 | 1153 | @subsection Folding Editing |
9577aa62 DL |
1154 | |
1155 | @cindex folding editing | |
2e6d3a80 RS |
1156 | The Foldout package extends Outline mode and Outline minor mode with |
1157 | ``folding'' commands. The idea of folding is that you zoom in on a | |
1158 | nested portion of the outline, while hiding its relatives at higher | |
1159 | levels. | |
ef940469 | 1160 | |
2e6d3a80 | 1161 | Consider an Outline mode buffer all the text and subheadings under |
9577aa62 | 1162 | level-1 headings hidden. To look at what is hidden under one of these |
2e6d3a80 RS |
1163 | headings, you could use @kbd{C-c C-e} (@kbd{M-x show-entry}) to expose |
1164 | the body, or @kbd{C-c C-i} to expose the child (level-2) headings. | |
9577aa62 DL |
1165 | |
1166 | @kindex C-c C-z | |
1167 | @findex foldout-zoom-subtree | |
2e6d3a80 RS |
1168 | With Foldout, you use @kbd{C-c C-z} (@kbd{M-x foldout-zoom-subtree}). |
1169 | This exposes the body and child subheadings, and narrows the buffer so | |
9577aa62 DL |
1170 | that only the level-1 heading, the body and the level-2 headings are |
1171 | visible. Now to look under one of the level-2 headings, position the | |
1172 | cursor on it and use @kbd{C-c C-z} again. This exposes the level-2 body | |
1173 | and its level-3 child subheadings and narrows the buffer again. Zooming | |
1174 | in on successive subheadings can be done as much as you like. A string | |
1175 | in the modeline shows how deep you've gone. | |
1176 | ||
2e6d3a80 | 1177 | When zooming in on a heading, to see only the child subheadings specify |
9577aa62 DL |
1178 | a numeric argument: @kbd{C-u C-c C-z}. The number of levels of children |
1179 | can be specified too (compare @kbd{M-x show-children}), e.g.@: @kbd{M-2 | |
1180 | C-c C-z} exposes two levels of child subheadings. Alternatively, the | |
1181 | body can be spcified with a negative argument: @kbd{M-- C-c C-z}. The | |
1182 | whole subtree can be expanded, similarly to @kbd{C-c C-s} (@kbd{M-x | |
1183 | show-subtree}), by specifying a zero argument: @kbd{M-0 C-c C-z}. | |
1184 | ||
2e6d3a80 | 1185 | While you're zoomed in, you can still use Outline mode's exposure and |
9577aa62 | 1186 | hiding functions without disturbing Foldout. Also, since the buffer is |
2e6d3a80 | 1187 | narrowed, ``global'' editing actions will only affect text under the |
9577aa62 DL |
1188 | zoomed-in heading. This is useful for restricting changes to a |
1189 | particular chapter or section of your document. | |
1190 | ||
1191 | @kindex C-c C-x | |
1192 | @findex foldout-exit-fold | |
2e6d3a80 | 1193 | To unzoom (exit) a fold, use @kbd{C-c C-x} (@kbd{M-x foldout-exit-fold}). |
9577aa62 DL |
1194 | This hides all the text and subheadings under the top-level heading and |
1195 | returns you to the previous view of the buffer. Specifying a numeric | |
2e6d3a80 | 1196 | argument exits that many levels of folds. Specifying a zero argument exits all |
9577aa62 DL |
1197 | folds. |
1198 | ||
2e6d3a80 RS |
1199 | To cancel the narrowing of a fold without hiding the text and |
1200 | subheadings, specify a negative argument. For example, @kbd{M--2 C-c | |
1201 | C-x} exits two folds and leaves the text and subheadings exposed. | |
1202 | ||
1203 | Foldout mode also provides mouse commands for entering and exiting | |
1204 | folds, and for showing and hiding text: | |
9577aa62 | 1205 | |
9577aa62 | 1206 | @table @asis |
2e6d3a80 | 1207 | @item @kbd{M-C-Mouse-1} zooms in on the heading clicked on |
9577aa62 DL |
1208 | @table @asis |
1209 | @item single click | |
2e6d3a80 | 1210 | expose body. |
9577aa62 | 1211 | @item double click |
2e6d3a80 | 1212 | expose subheadings. |
9577aa62 | 1213 | @item triple click |
2e6d3a80 | 1214 | expose body and subheadings. |
9577aa62 | 1215 | @item quad click |
2e6d3a80 | 1216 | expose entire subtree. |
9577aa62 | 1217 | @end table |
2e6d3a80 | 1218 | @item @kbd{M-C-Mouse-2} exposes text under the heading clicked on |
9577aa62 DL |
1219 | @table @r |
1220 | @item single click | |
2e6d3a80 | 1221 | expose body. |
9577aa62 | 1222 | @item double click |
2e6d3a80 | 1223 | expose subheadings. |
9577aa62 | 1224 | @item triple click |
2e6d3a80 | 1225 | expose body and subheadings. |
9577aa62 | 1226 | @item quad click |
2e6d3a80 | 1227 | expose entire subtree. |
9577aa62 | 1228 | @end table |
2e6d3a80 | 1229 | @item @kbd{M-C-Mouse-3} hides text under the heading clicked on or exits fold |
9577aa62 DL |
1230 | @table @r |
1231 | @item single click | |
2e6d3a80 | 1232 | hide subtree. |
9577aa62 | 1233 | @item double click |
2e6d3a80 | 1234 | exit fold and hide text. |
9577aa62 | 1235 | @item triple click |
2e6d3a80 | 1236 | exit fold without hiding text. |
9577aa62 | 1237 | @item quad click |
2e6d3a80 | 1238 | exit all folds and hide text. |
9577aa62 DL |
1239 | @end table |
1240 | @end table | |
1241 | ||
1242 | @vindex foldout-mouse-modifiers | |
2e6d3a80 RS |
1243 | You can specify different modifier keys (instead of |
1244 | @kbd{Control-Meta-}) by setting @code{foldout-mouse-modifiers}; but if | |
1245 | you have already loaded the @file{foldout.el} library, you must reload | |
1246 | it in order for this to take effect. | |
1247 | ||
1248 | To use the Foldout package, you can type @kbd{M-x load-library | |
1249 | @key{RET} foldout @key{RET}}; or you can arrange for to do that | |
1250 | automatically by putting this in your @file{.emacs} file: | |
1251 | ||
1252 | @example | |
1253 | (eval-after-load "outline" '(require 'foldout)) | |
1254 | @end example | |
9577aa62 DL |
1255 | |
1256 | @node TeX Mode, Nroff Mode, Outline Mode, Text | |
6bf7aab6 DL |
1257 | @section @TeX{} Mode |
1258 | @cindex @TeX{} mode | |
1259 | @cindex La@TeX{} mode | |
1260 | @cindex Sli@TeX{} mode | |
1261 | @cindex mode, @TeX{} | |
1262 | @cindex mode, La@TeX{} | |
1263 | @cindex mode, Sli@TeX{} | |
1264 | @findex tex-mode | |
1265 | @findex plain-tex-mode | |
1266 | @findex latex-mode | |
1267 | @findex slitex-mode | |
1268 | ||
1269 | @TeX{} is a powerful text formatter written by Donald Knuth; it is also | |
1270 | free, like GNU Emacs. La@TeX{} is a simplified input format for @TeX{}, | |
1271 | implemented by @TeX{} macros; it comes with @TeX{}. Sli@TeX{} is a special | |
ef940469 DL |
1272 | form of La@TeX{}.@footnote{Sli@TeX{} is obsoleted by the @samp{slides} |
1273 | document class in recent La@TeX{} versions.} | |
6bf7aab6 DL |
1274 | |
1275 | Emacs has a special @TeX{} mode for editing @TeX{} input files. | |
1276 | It provides facilities for checking the balance of delimiters and for | |
1277 | invoking @TeX{} on all or part of the file. | |
1278 | ||
1279 | @vindex tex-default-mode | |
1280 | @TeX{} mode has three variants, Plain @TeX{} mode, La@TeX{} mode, and | |
1281 | Sli@TeX{} mode (these three distinct major modes differ only slightly). | |
1282 | They are designed for editing the three different formats. The command | |
1283 | @kbd{M-x tex-mode} looks at the contents of the buffer to determine | |
1284 | whether the contents appear to be either La@TeX{} input or Sli@TeX{} | |
1285 | input; if so, it selects the appropriate mode. If the file contents do | |
1286 | not appear to be La@TeX{} or Sli@TeX{}, it selects Plain @TeX{} mode. | |
1287 | If the contents are insufficient to determine this, the variable | |
1288 | @code{tex-default-mode} controls which mode is used. | |
1289 | ||
1290 | When @kbd{M-x tex-mode} does not guess right, you can use the commands | |
1291 | @kbd{M-x plain-tex-mode}, @kbd{M-x latex-mode}, and @kbd{M-x | |
1292 | slitex-mode} to select explicitly the particular variants of @TeX{} | |
1293 | mode. | |
1294 | ||
6bf7aab6 DL |
1295 | @menu |
1296 | * Editing: TeX Editing. Special commands for editing in TeX mode. | |
1297 | * LaTeX: LaTeX Editing. Additional commands for LaTeX input files. | |
1298 | * Printing: TeX Print. Commands for printing part of a file with TeX. | |
2e6d3a80 | 1299 | * Misc: TeX Misc. Customization of TeX mode, and related features. |
6bf7aab6 DL |
1300 | @end menu |
1301 | ||
1302 | @node TeX Editing | |
1303 | @subsection @TeX{} Editing Commands | |
1304 | ||
1305 | Here are the special commands provided in @TeX{} mode for editing the | |
1306 | text of the file. | |
1307 | ||
1308 | @table @kbd | |
1309 | @item " | |
1310 | Insert, according to context, either @samp{``} or @samp{"} or | |
1311 | @samp{''} (@code{tex-insert-quote}). | |
1312 | @item C-j | |
1313 | Insert a paragraph break (two newlines) and check the previous | |
1314 | paragraph for unbalanced braces or dollar signs | |
1315 | (@code{tex-terminate-paragraph}). | |
1316 | @item M-x tex-validate-region | |
1317 | Check each paragraph in the region for unbalanced braces or dollar signs. | |
1318 | @item C-c @{ | |
1319 | Insert @samp{@{@}} and position point between them (@code{tex-insert-braces}). | |
1320 | @item C-c @} | |
1321 | Move forward past the next unmatched close brace (@code{up-list}). | |
1322 | @end table | |
1323 | ||
1324 | @findex tex-insert-quote | |
1325 | @kindex " @r{(@TeX{} mode)} | |
1326 | In @TeX{}, the character @samp{"} is not normally used; we use | |
1327 | @samp{``} to start a quotation and @samp{''} to end one. To make | |
1328 | editing easier under this formatting convention, @TeX{} mode overrides | |
1329 | the normal meaning of the key @kbd{"} with a command that inserts a pair | |
1330 | of single-quotes or backquotes (@code{tex-insert-quote}). To be | |
1331 | precise, this command inserts @samp{``} after whitespace or an open | |
1332 | brace, @samp{"} after a backslash, and @samp{''} after any other | |
1333 | character. | |
1334 | ||
1335 | If you need the character @samp{"} itself in unusual contexts, use | |
1336 | @kbd{C-q} to insert it. Also, @kbd{"} with a numeric argument always | |
1337 | inserts that number of @samp{"} characters. You can turn off the | |
1338 | feature of @kbd{"} expansion by eliminating that binding in the local | |
1339 | map (@pxref{Key Bindings}). | |
1340 | ||
1341 | In @TeX{} mode, @samp{$} has a special syntax code which attempts to | |
1342 | understand the way @TeX{} math mode delimiters match. When you insert a | |
1343 | @samp{$} that is meant to exit math mode, the position of the matching | |
1344 | @samp{$} that entered math mode is displayed for a second. This is the | |
1345 | same feature that displays the open brace that matches a close brace that | |
1346 | is inserted. However, there is no way to tell whether a @samp{$} enters | |
1347 | math mode or leaves it; so when you insert a @samp{$} that enters math | |
1348 | mode, the previous @samp{$} position is shown as if it were a match, even | |
1349 | though they are actually unrelated. | |
1350 | ||
1351 | @findex tex-insert-braces | |
1352 | @kindex C-c @{ @r{(@TeX{} mode)} | |
1353 | @findex up-list | |
1354 | @kindex C-c @} @r{(@TeX{} mode)} | |
1355 | @TeX{} uses braces as delimiters that must match. Some users prefer | |
1356 | to keep braces balanced at all times, rather than inserting them | |
1357 | singly. Use @kbd{C-c @{} (@code{tex-insert-braces}) to insert a pair of | |
1358 | braces. It leaves point between the two braces so you can insert the | |
1359 | text that belongs inside. Afterward, use the command @kbd{C-c @}} | |
1360 | (@code{up-list}) to move forward past the close brace. | |
1361 | ||
1362 | @findex tex-validate-region | |
1363 | @findex tex-terminate-paragraph | |
1364 | @kindex C-j @r{(@TeX{} mode)} | |
1365 | There are two commands for checking the matching of braces. @kbd{C-j} | |
1366 | (@code{tex-terminate-paragraph}) checks the paragraph before point, and | |
1367 | inserts two newlines to start a new paragraph. It prints a message in | |
1368 | the echo area if any mismatch is found. @kbd{M-x tex-validate-region} | |
1369 | checks a region, paragraph by paragraph. The errors are listed in the | |
1370 | @samp{*Occur*} buffer, and you can use @kbd{C-c C-c} or @kbd{Mouse-2} in | |
1371 | that buffer to go to a particular mismatch. | |
1372 | ||
1373 | Note that Emacs commands count square brackets and parentheses in | |
1374 | @TeX{} mode, not just braces. This is not strictly correct for the | |
1375 | purpose of checking @TeX{} syntax. However, parentheses and square | |
1376 | brackets are likely to be used in text as matching delimiters and it is | |
1377 | useful for the various motion commands and automatic match display to | |
1378 | work with them. | |
1379 | ||
1380 | @node LaTeX Editing | |
1381 | @subsection La@TeX{} Editing Commands | |
1382 | ||
1383 | La@TeX{} mode, and its variant, Sli@TeX{} mode, provide a few extra | |
1384 | features not applicable to plain @TeX{}. | |
1385 | ||
1386 | @table @kbd | |
1387 | @item C-c C-o | |
1388 | Insert @samp{\begin} and @samp{\end} for La@TeX{} block and position | |
1389 | point on a line between them (@code{tex-latex-block}). | |
1390 | @item C-c C-e | |
1391 | Close the innermost La@TeX{} block not yet closed | |
1392 | (@code{tex-close-latex-block}). | |
1393 | @end table | |
1394 | ||
1395 | @findex tex-latex-block | |
1396 | @kindex C-c C-o @r{(La@TeX{} mode)} | |
1397 | @vindex latex-block-names | |
1398 | In La@TeX{} input, @samp{\begin} and @samp{\end} commands are used to | |
1399 | group blocks of text. To insert a @samp{\begin} and a matching | |
1400 | @samp{\end} (on a new line following the @samp{\begin}), use @kbd{C-c | |
1401 | C-o} (@code{tex-latex-block}). A blank line is inserted between the | |
1402 | two, and point is left there. You can use completion when you enter the | |
1403 | block type; to specify additional block type names beyond the standard | |
1404 | list, set the variable @code{latex-block-names}. For example, here's | |
1405 | how to add @samp{theorem}, @samp{corollary}, and @samp{proof}: | |
1406 | ||
1407 | @example | |
1408 | (setq latex-block-names '("theorem" "corollary" "proof")) | |
1409 | @end example | |
1410 | ||
1411 | @findex tex-close-latex-block | |
1412 | @kindex C-c C-e @r{(La@TeX{} mode)} | |
1413 | In La@TeX{} input, @samp{\begin} and @samp{\end} commands must | |
1414 | balance. You can use @kbd{C-c C-e} (@code{tex-close-latex-block}) to | |
1415 | insert automatically a matching @samp{\end} to match the last unmatched | |
1416 | @samp{\begin}. It indents the @samp{\end} to match the corresponding | |
1417 | @samp{\begin}. It inserts a newline after @samp{\end} if point is at | |
1418 | the beginning of a line. | |
1419 | ||
1420 | @node TeX Print | |
1421 | @subsection @TeX{} Printing Commands | |
1422 | ||
1423 | You can invoke @TeX{} as an inferior of Emacs on either the entire | |
1424 | contents of the buffer or just a region at a time. Running @TeX{} in | |
1425 | this way on just one chapter is a good way to see what your changes | |
1426 | look like without taking the time to format the entire file. | |
1427 | ||
1428 | @table @kbd | |
1429 | @item C-c C-r | |
1430 | Invoke @TeX{} on the current region, together with the buffer's header | |
1431 | (@code{tex-region}). | |
1432 | @item C-c C-b | |
1433 | Invoke @TeX{} on the entire current buffer (@code{tex-buffer}). | |
1434 | @item C-c @key{TAB} | |
1435 | Invoke Bib@TeX{} on the current file (@code{tex-bibtex-file}). | |
1436 | @item C-c C-f | |
1437 | Invoke @TeX{} on the current file (@code{tex-file}). | |
1438 | @item C-c C-l | |
1439 | Recenter the window showing output from the inferior @TeX{} so that | |
1440 | the last line can be seen (@code{tex-recenter-output-buffer}). | |
1441 | @item C-c C-k | |
1442 | Kill the @TeX{} subprocess (@code{tex-kill-job}). | |
1443 | @item C-c C-p | |
1444 | Print the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c | |
1445 | C-f} command (@code{tex-print}). | |
1446 | @item C-c C-v | |
1447 | Preview the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c | |
1448 | C-f} command (@code{tex-view}). | |
1449 | @item C-c C-q | |
1450 | Show the printer queue (@code{tex-show-print-queue}). | |
1451 | @end table | |
1452 | ||
1453 | @findex tex-buffer | |
1454 | @kindex C-c C-b @r{(@TeX{} mode)} | |
1455 | @findex tex-print | |
1456 | @kindex C-c C-p @r{(@TeX{} mode)} | |
1457 | @findex tex-view | |
1458 | @kindex C-c C-v @r{(@TeX{} mode)} | |
1459 | @findex tex-show-print-queue | |
1460 | @kindex C-c C-q @r{(@TeX{} mode)} | |
1461 | You can pass the current buffer through an inferior @TeX{} by means of | |
1462 | @kbd{C-c C-b} (@code{tex-buffer}). The formatted output appears in a | |
1463 | temporary file; to print it, type @kbd{C-c C-p} (@code{tex-print}). | |
1464 | Afterward, you can use @kbd{C-c C-q} (@code{tex-show-print-queue}) to | |
1465 | view the progress of your output towards being printed. If your terminal | |
1466 | has the ability to display @TeX{} output files, you can preview the | |
1467 | output on the terminal with @kbd{C-c C-v} (@code{tex-view}). | |
1468 | ||
60a96371 | 1469 | @cindex @env{TEXINPUTS} environment variable |
6bf7aab6 DL |
1470 | @vindex tex-directory |
1471 | You can specify the directory to use for running @TeX{} by setting the | |
1472 | variable @code{tex-directory}. @code{"."} is the default value. If | |
60a96371 | 1473 | your environment variable @env{TEXINPUTS} contains relative directory |
6bf7aab6 DL |
1474 | names, or if your files contains @samp{\input} commands with relative |
1475 | file names, then @code{tex-directory} @emph{must} be @code{"."} or you | |
1476 | will get the wrong results. Otherwise, it is safe to specify some other | |
1477 | directory, such as @code{"/tmp"}. | |
1478 | ||
1479 | @vindex tex-run-command | |
1480 | @vindex latex-run-command | |
1481 | @vindex slitex-run-command | |
1482 | @vindex tex-dvi-print-command | |
1483 | @vindex tex-dvi-view-command | |
1484 | @vindex tex-show-queue-command | |
1485 | If you want to specify which shell commands are used in the inferior @TeX{}, | |
1486 | you can do so by setting the values of the variables @code{tex-run-command}, | |
1487 | @code{latex-run-command}, @code{slitex-run-command}, | |
1488 | @code{tex-dvi-print-command}, @code{tex-dvi-view-command}, and | |
1489 | @code{tex-show-queue-command}. You @emph{must} set the value of | |
1490 | @code{tex-dvi-view-command} for your particular terminal; this variable | |
1491 | has no default value. The other variables have default values that may | |
1492 | (or may not) be appropriate for your system. | |
1493 | ||
1494 | Normally, the file name given to these commands comes at the end of | |
1495 | the command string; for example, @samp{latex @var{filename}}. In some | |
1496 | cases, however, the file name needs to be embedded in the command; an | |
1497 | example is when you need to provide the file name as an argument to one | |
1498 | command whose output is piped to another. You can specify where to put | |
1499 | the file name with @samp{*} in the command string. For example, | |
1500 | ||
1501 | @example | |
1502 | (setq tex-dvi-print-command "dvips -f * | lpr") | |
1503 | @end example | |
1504 | ||
1505 | @findex tex-kill-job | |
1506 | @kindex C-c C-k @r{(@TeX{} mode)} | |
1507 | @findex tex-recenter-output-buffer | |
1508 | @kindex C-c C-l @r{(@TeX{} mode)} | |
1509 | The terminal output from @TeX{}, including any error messages, appears | |
1510 | in a buffer called @samp{*tex-shell*}. If @TeX{} gets an error, you can | |
1511 | switch to this buffer and feed it input (this works as in Shell mode; | |
1512 | @pxref{Interactive Shell}). Without switching to this buffer you can | |
1513 | scroll it so that its last line is visible by typing @kbd{C-c | |
1514 | C-l}. | |
1515 | ||
1516 | Type @kbd{C-c C-k} (@code{tex-kill-job}) to kill the @TeX{} process if | |
1517 | you see that its output is no longer useful. Using @kbd{C-c C-b} or | |
1518 | @kbd{C-c C-r} also kills any @TeX{} process still running.@refill | |
1519 | ||
1520 | @findex tex-region | |
1521 | @kindex C-c C-r @r{(@TeX{} mode)} | |
1522 | You can also pass an arbitrary region through an inferior @TeX{} by typing | |
1523 | @kbd{C-c C-r} (@code{tex-region}). This is tricky, however, because most files | |
1524 | of @TeX{} input contain commands at the beginning to set parameters and | |
1525 | define macros, without which no later part of the file will format | |
1526 | correctly. To solve this problem, @kbd{C-c C-r} allows you to designate a | |
1527 | part of the file as containing essential commands; it is included before | |
1528 | the specified region as part of the input to @TeX{}. The designated part | |
1529 | of the file is called the @dfn{header}. | |
1530 | ||
1531 | @cindex header (@TeX{} mode) | |
1532 | To indicate the bounds of the header in Plain @TeX{} mode, you insert two | |
1533 | special strings in the file. Insert @samp{%**start of header} before the | |
1534 | header, and @samp{%**end of header} after it. Each string must appear | |
1535 | entirely on one line, but there may be other text on the line before or | |
1536 | after. The lines containing the two strings are included in the header. | |
1537 | If @samp{%**start of header} does not appear within the first 100 lines of | |
1538 | the buffer, @kbd{C-c C-r} assumes that there is no header. | |
1539 | ||
1540 | In La@TeX{} mode, the header begins with @samp{\documentclass} or | |
1541 | @samp{\documentstyle} and ends with @samp{\begin@{document@}}. These | |
1542 | are commands that La@TeX{} requires you to use in any case, so nothing | |
1543 | special needs to be done to identify the header. | |
1544 | ||
1545 | @findex tex-file | |
1546 | @kindex C-c C-f @r{(@TeX{} mode)} | |
1547 | The commands (@code{tex-buffer}) and (@code{tex-region}) do all of their | |
1548 | work in a temporary directory, and do not have available any of the auxiliary | |
1549 | files needed by @TeX{} for cross-references; these commands are generally | |
1550 | not suitable for running the final copy in which all of the cross-references | |
1551 | need to be correct. | |
1552 | ||
1553 | When you want the auxiliary files for cross references, use @kbd{C-c | |
1554 | C-f} (@code{tex-file}) which runs @TeX{} on the current buffer's file, | |
1555 | in that file's directory. Before running @TeX{}, it offers to save any | |
1556 | modified buffers. Generally, you need to use (@code{tex-file}) twice to | |
1557 | get the cross-references right. | |
1558 | ||
1559 | @vindex tex-start-options-string | |
1560 | The value of the variable @code{tex-start-options-string} specifies | |
1561 | options for the @TeX{} run. The default value causes @TeX{} to run in | |
1562 | nonstopmode. To run @TeX{} interactively, set the variable to @code{""}. | |
1563 | ||
1564 | @vindex tex-main-file | |
1565 | Large @TeX{} documents are often split into several files---one main | |
1566 | file, plus subfiles. Running @TeX{} on a subfile typically does not | |
1567 | work; you have to run it on the main file. In order to make | |
1568 | @code{tex-file} useful when you are editing a subfile, you can set the | |
1569 | variable @code{tex-main-file} to the name of the main file. Then | |
1570 | @code{tex-file} runs @TeX{} on that file. | |
1571 | ||
1572 | The most convenient way to use @code{tex-main-file} is to specify it | |
1573 | in a local variable list in each of the subfiles. @xref{File | |
1574 | Variables}. | |
1575 | ||
1576 | @findex tex-bibtex-file | |
1577 | @kindex C-c TAB @r{(@TeX{} mode)} | |
1578 | @vindex tex-bibtex-command | |
1579 | For La@TeX{} files, you can use Bib@TeX{} to process the auxiliary | |
1580 | file for the current buffer's file. Bib@TeX{} looks up bibliographic | |
1581 | citations in a data base and prepares the cited references for the | |
1582 | bibliography section. The command @kbd{C-c TAB} | |
1583 | (@code{tex-bibtex-file}) runs the shell command | |
1584 | (@code{tex-bibtex-command}) to produce a @samp{.bbl} file for the | |
1585 | current buffer's file. Generally, you need to do @kbd{C-c C-f} | |
1586 | (@code{tex-file}) once to generate the @samp{.aux} file, then do | |
1587 | @kbd{C-c TAB} (@code{tex-bibtex-file}), and then repeat @kbd{C-c C-f} | |
1588 | (@code{tex-file}) twice more to get the cross-references correct. | |
1589 | ||
2e6d3a80 RS |
1590 | @node TeX Misc |
1591 | @subsection @TeX{} Mode Miscellany | |
1592 | ||
1593 | @vindex tex-shell-hook | |
1594 | @vindex tex-mode-hook | |
1595 | @vindex latex-mode-hook | |
1596 | @vindex slitex-mode-hook | |
1597 | @vindex plain-tex-mode-hook | |
1598 | Entering any variant of @TeX{} mode runs the hooks | |
1599 | @code{text-mode-hook} and @code{tex-mode-hook}. Then it runs either | |
1600 | @code{plain-tex-mode-hook}, @code{latex-mode-hook}, or | |
1601 | @code{slitex-mode-hook}, whichever is appropriate. Starting the | |
1602 | @TeX{} shell runs the hook @code{tex-shell-hook}. @xref{Hooks}. | |
1603 | ||
1604 | @findex iso-iso2tex | |
1605 | @findex iso-tex2iso | |
1606 | @findex iso-iso2gtex | |
1607 | @findex iso-gtex2iso | |
1608 | @cindex Latin-1 @TeX{} encoding | |
1609 | @TeX{} encoding | |
2e6d3a80 RS |
1610 | The commands @kbd{M-x iso-iso2tex}, @kbd{M-x iso-tex2iso}, @kbd{M-x |
1611 | iso-iso2gtex} and @kbd{M-x iso-gtex2iso} can be used to convert | |
1612 | between Latin-1 encoded files and @TeX{}-encoded equivalents. | |
1613 | @ignore | |
1614 | @c Too cryptic to be useful, too cryptic for me to make it better -- rms. | |
1615 | They | |
1616 | are included by default in the @code{format-alist} variable, so they | |
1617 | can be used with @kbd{M-x format-find-file}, for instance. | |
1618 | @end ignore | |
1619 | ||
1620 | @ignore @c Not worth documenting if it is only for Czech -- rms. | |
1621 | @findex tildify-buffer | |
1622 | @findex tildify-region | |
1623 | @cindex ties, @TeX{}, inserting | |
1624 | @cindex hard spaces, @TeX{}, inserting | |
1625 | @cindex SGML | |
1626 | @cindex HTML | |
1627 | The commands @kbd{M-x tildify-buffer} and @kbd{M-x tildify-region} | |
1628 | insert @samp{~} (@dfn{tie}) characters where they are conventionally | |
1629 | required. This is set up for Czech---customize the group | |
1630 | @samp{tildify} for other languages or for other sorts of markup. | |
1631 | @end ignore | |
1632 | ||
1633 | @cindex Ref@TeX{} package | |
1634 | @cindex references, La@TeX{} | |
1635 | @cindex La@TeX{} references | |
1636 | For managing all kinds of references for La@TeX{}, you can use | |
1637 | Ref@TeX{}. @xref{Top, , RefTeX, reftex}. | |
1638 | ||
6bf7aab6 DL |
1639 | @node Nroff Mode |
1640 | @section Nroff Mode | |
1641 | ||
1642 | @cindex nroff | |
1643 | @findex nroff-mode | |
1644 | Nroff mode is a mode like Text mode but modified to handle nroff commands | |
1645 | present in the text. Invoke @kbd{M-x nroff-mode} to enter this mode. It | |
1646 | differs from Text mode in only a few ways. All nroff command lines are | |
1647 | considered paragraph separators, so that filling will never garble the | |
1648 | nroff commands. Pages are separated by @samp{.bp} commands. Comments | |
1649 | start with backslash-doublequote. Also, three special commands are | |
1650 | provided that are not in Text mode: | |
1651 | ||
1652 | @findex forward-text-line | |
1653 | @findex backward-text-line | |
1654 | @findex count-text-lines | |
1655 | @kindex M-n @r{(Nroff mode)} | |
1656 | @kindex M-p @r{(Nroff mode)} | |
1657 | @kindex M-? @r{(Nroff mode)} | |
1658 | @table @kbd | |
1659 | @item M-n | |
1660 | Move to the beginning of the next line that isn't an nroff command | |
1661 | (@code{forward-text-line}). An argument is a repeat count. | |
1662 | @item M-p | |
1663 | Like @kbd{M-n} but move up (@code{backward-text-line}). | |
1664 | @item M-? | |
1665 | Prints in the echo area the number of text lines (lines that are not | |
1666 | nroff commands) in the region (@code{count-text-lines}). | |
1667 | @end table | |
1668 | ||
1669 | @findex electric-nroff-mode | |
1670 | The other feature of Nroff mode is that you can turn on Electric Nroff | |
1671 | mode. This is a minor mode that you can turn on or off with @kbd{M-x | |
1672 | electric-nroff-mode} (@pxref{Minor Modes}). When the mode is on, each | |
1673 | time you use @key{RET} to end a line that contains an nroff command that | |
1674 | opens a kind of grouping, the matching nroff command to close that | |
1675 | grouping is automatically inserted on the following line. For example, | |
1676 | if you are at the beginning of a line and type @kbd{.@: ( b @key{RET}}, | |
1677 | this inserts the matching command @samp{.)b} on a new line following | |
1678 | point. | |
1679 | ||
1680 | If you use Outline minor mode with Nroff mode (@pxref{Outline Mode}), | |
1681 | heading lines are lines of the form @samp{.H} followed by a number (the | |
1682 | header level). | |
1683 | ||
1684 | @vindex nroff-mode-hook | |
1685 | Entering Nroff mode runs the hook @code{text-mode-hook}, followed by | |
1686 | the hook @code{nroff-mode-hook} (@pxref{Hooks}). | |
1687 | ||
1688 | @node Formatted Text | |
1689 | @section Editing Formatted Text | |
1690 | ||
1691 | @cindex Enriched mode | |
1692 | @cindex mode, Enriched | |
1693 | @cindex formatted text | |
1694 | @cindex WYSIWYG | |
1695 | @cindex word processing | |
1696 | @dfn{Enriched mode} is a minor mode for editing files that contain | |
1697 | formatted text in WYSIWYG fashion, as in a word processor. Currently, | |
1698 | formatted text in Enriched mode can specify fonts, colors, underlining, | |
1699 | margins, and types of filling and justification. In the future, we plan | |
1700 | to implement other formatting features as well. | |
1701 | ||
1702 | Enriched mode is a minor mode (@pxref{Minor Modes}). Typically it is | |
1703 | used in conjunction with Text mode (@pxref{Text Mode}). However, you | |
1704 | can also use it with other major modes such as Outline mode and | |
1705 | Paragraph-Indent Text mode. | |
1706 | ||
ef940469 | 1707 | @cindex text/enriched MIME format |
6bf7aab6 DL |
1708 | Potentially, Emacs can store formatted text files in various file |
1709 | formats. Currently, only one format is implemented: @dfn{text/enriched} | |
1710 | format, which is defined by the MIME protocol. @xref{Format | |
1711 | Conversion,, Format Conversion, elisp, the Emacs Lisp Reference Manual}, | |
1712 | for details of how Emacs recognizes and converts file formats. | |
1713 | ||
1714 | The Emacs distribution contains a formatted text file that can serve as | |
1715 | an example. Its name is @file{etc/enriched.doc}. It contains samples | |
1716 | illustrating all the features described in this section. It also | |
1717 | contains a list of ideas for future enhancements. | |
1718 | ||
1719 | @menu | |
1720 | * Requesting Formatted Text:: Entering and exiting Enriched mode. | |
1721 | * Hard and Soft Newlines:: There are two different kinds of newlines. | |
1722 | * Editing Format Info:: How to edit text properties. | |
1723 | * Faces: Format Faces. Bold, italic, underline, etc. | |
1724 | * Color: Format Colors. Changing the color of text. | |
1725 | * Indent: Format Indentation. Changing the left and right margins. | |
1726 | * Justification: Format Justification. | |
1727 | Centering, setting text flush with the | |
1728 | left or right margin, etc. | |
1729 | * Other: Format Properties. The "special" text properties submenu. | |
1730 | * Forcing Enriched Mode:: How to force use of Enriched mode. | |
1731 | @end menu | |
1732 | ||
1733 | @node Requesting Formatted Text | |
1734 | @subsection Requesting to Edit Formatted Text | |
1735 | ||
1736 | Whenever you visit a file that Emacs saved in the text/enriched format, | |
1737 | Emacs automatically converts the formatting information in the file into | |
1738 | Emacs's own internal format (text properties), and turns on Enriched | |
1739 | mode. | |
1740 | ||
1741 | @findex enriched-mode | |
1742 | To create a new file of formatted text, first visit the nonexistent | |
1743 | file, then type @kbd{M-x enriched-mode} before you start inserting text. | |
1744 | This command turns on Enriched mode. Do this before you begin inserting | |
1745 | text, to ensure that the text you insert is handled properly. | |
1746 | ||
1747 | More generally, the command @code{enriched-mode} turns Enriched mode | |
1748 | on if it was off, and off if it was on. With a prefix argument, this | |
1749 | command turns Enriched mode on if the argument is positive, and turns | |
1750 | the mode off otherwise. | |
1751 | ||
1752 | When you save a buffer while Enriched mode is enabled in it, Emacs | |
1753 | automatically converts the text to text/enriched format while writing it | |
1754 | into the file. When you visit the file again, Emacs will automatically | |
1755 | recognize the format, reconvert the text, and turn on Enriched mode | |
1756 | again. | |
1757 | ||
1758 | @vindex enriched-fill-after-visiting | |
1759 | Normally, after visiting a file in text/enriched format, Emacs refills | |
1760 | each paragraph to fit the specified right margin. You can turn off this | |
1761 | refilling, to save time, by setting the variable | |
1762 | @code{enriched-fill-after-visiting} to @code{nil} or to @code{ask}. | |
1763 | ||
1764 | However, when visiting a file that was saved from Enriched mode, there | |
1765 | is no need for refilling, because Emacs saves the right margin settings | |
1766 | along with the text. | |
1767 | ||
1768 | @vindex enriched-translations | |
1769 | You can add annotations for saving additional text properties, which | |
1770 | Emacs normally does not save, by adding to @code{enriched-translations}. | |
1771 | Note that the text/enriched standard requires any non-standard | |
1772 | annotations to have names starting with @samp{x-}, as in | |
1773 | @samp{x-read-only}. This ensures that they will not conflict with | |
1774 | standard annotations that may be added later. | |
1775 | ||
1776 | @node Hard and Soft Newlines | |
1777 | @subsection Hard and Soft Newlines | |
1778 | @cindex hard newline | |
1779 | @cindex soft newline | |
1780 | @cindex newlines, hard and soft | |
1781 | ||
1782 | In formatted text, Emacs distinguishes between two different kinds of | |
1783 | newlines, @dfn{hard} newlines and @dfn{soft} newlines. | |
1784 | ||
1785 | Hard newlines are used to separate paragraphs, or items in a list, or | |
1786 | anywhere that there should always be a line break regardless of the | |
1787 | margins. The @key{RET} command (@code{newline}) and @kbd{C-o} | |
1788 | (@code{open-line}) insert hard newlines. | |
1789 | ||
1790 | Soft newlines are used to make text fit between the margins. All the | |
1791 | fill commands, including Auto Fill, insert soft newlines---and they | |
1792 | delete only soft newlines. | |
1793 | ||
1794 | Although hard and soft newlines look the same, it is important to bear | |
1795 | the difference in mind. Do not use @key{RET} to break lines in the | |
1796 | middle of filled paragraphs, or else you will get hard newlines that are | |
1797 | barriers to further filling. Instead, let Auto Fill mode break lines, | |
1798 | so that if the text or the margins change, Emacs can refill the lines | |
1799 | properly. @xref{Auto Fill}. | |
1800 | ||
1801 | On the other hand, in tables and lists, where the lines should always | |
1802 | remain as you type them, you can use @key{RET} to end lines. For these | |
1803 | lines, you may also want to set the justification style to | |
1804 | @code{unfilled}. @xref{Format Justification}. | |
1805 | ||
1806 | @node Editing Format Info | |
1807 | @subsection Editing Format Information | |
1808 | ||
1809 | There are two ways to alter the formatting information for a formatted | |
1810 | text file: with keyboard commands, and with the mouse. | |
1811 | ||
1812 | The easiest way to add properties to your document is by using the Text | |
1813 | Properties menu. You can get to this menu in two ways: from the Edit | |
2e6d3a80 | 1814 | menu in the menu bar, or with @kbd{C-Mouse-2} (hold the @key{CTRL} key |
6bf7aab6 DL |
1815 | and press the middle mouse button). |
1816 | ||
1817 | Most of the items in the Text Properties menu lead to other submenus. | |
1818 | These are described in the sections that follow. Some items run | |
1819 | commands directly: | |
1820 | ||
1821 | @table @code | |
1822 | @findex facemenu-remove-props | |
1823 | @item Remove Properties | |
1824 | Delete from the region all the text properties that the Text Properties | |
1825 | menu works with (@code{facemenu-remove-props}). | |
1826 | ||
1827 | @findex facemenu-remove-all | |
1828 | @item Remove All | |
1829 | Delete @emph{all} text properties from the region | |
1830 | (@code{facemenu-remove-all}). | |
1831 | ||
1832 | @findex list-text-properties-at | |
1833 | @item List Properties | |
1834 | List all the text properties of the character following point | |
1835 | (@code{list-text-properties-at}). | |
1836 | ||
1837 | @item Display Faces | |
1838 | Display a list of all the defined faces. | |
1839 | ||
1840 | @item Display Colors | |
1841 | Display a list of all the defined colors. | |
1842 | @end table | |
1843 | ||
1844 | @node Format Faces | |
1845 | @subsection Faces in Formatted Text | |
1846 | ||
1847 | The Faces submenu lists various Emacs faces including @code{bold}, | |
1848 | @code{italic}, and @code{underline}. Selecting one of these adds the | |
1849 | chosen face to the region. @xref{Faces}. You can also specify a face | |
1850 | with these keyboard commands: | |
1851 | ||
1852 | @table @kbd | |
1853 | @kindex M-g d @r{(Enriched mode)} | |
1854 | @findex facemenu-set-default | |
1855 | @item M-g d | |
1856 | Set the region, or the next inserted character, to the @code{default} face | |
1857 | (@code{facemenu-set-default}). | |
1858 | @kindex M-g b @r{(Enriched mode)} | |
1859 | @findex facemenu-set-bold | |
1860 | @item M-g b | |
1861 | Set the region, or the next inserted character, to the @code{bold} face | |
1862 | (@code{facemenu-set-bold}). | |
1863 | @kindex M-g i @r{(Enriched mode)} | |
1864 | @findex facemenu-set-italic | |
1865 | @item M-g i | |
1866 | Set the region, or the next inserted character, to the @code{italic} face | |
1867 | (@code{facemenu-set-italic}). | |
1868 | @kindex M-g l @r{(Enriched mode)} | |
1869 | @findex facemenu-set-bold-italic | |
1870 | @item M-g l | |
1871 | Set the region, or the next inserted character, to the @code{bold-italic} face | |
1872 | (@code{facemenu-set-bold-italic}). | |
1873 | @kindex M-g u @r{(Enriched mode)} | |
1874 | @findex facemenu-set-underline | |
1875 | @item M-g u | |
1876 | Set the region, or the next inserted character, to the @code{underline} face | |
1877 | (@code{facemenu-set-underline}). | |
1878 | @kindex M-g o @r{(Enriched mode)} | |
1879 | @findex facemenu-set-face | |
1880 | @item M-g o @var{face} @key{RET} | |
1881 | Set the region, or the next inserted character, to the face @var{face} | |
1882 | (@code{facemenu-set-face}). | |
1883 | @end table | |
1884 | ||
1885 | If you use these commands with a prefix argument---or, in Transient Mark | |
1886 | mode, if the region is not active---then these commands specify a face | |
1887 | to use for your next self-inserting input. @xref{Transient Mark}. This | |
1888 | applies to both the keyboard commands and the menu commands. | |
1889 | ||
1890 | Enriched mode defines two additional faces: @code{excerpt} and | |
1891 | @code{fixed}. These correspond to codes used in the text/enriched file | |
1892 | format. | |
1893 | ||
1894 | The @code{excerpt} face is intended for quotations. This face is the | |
1895 | same as @code{italic} unless you customize it (@pxref{Face Customization}). | |
1896 | ||
1897 | The @code{fixed} face is meant to say, ``Use a fixed-width font for this | |
1898 | part of the text.'' Emacs currently supports only fixed-width fonts; | |
1899 | therefore, the @code{fixed} annotation is not necessary now. However, | |
1900 | we plan to support variable width fonts in future Emacs versions, and | |
1901 | other systems that display text/enriched format may not use a | |
1902 | fixed-width font as the default. So if you specifically want a certain | |
1903 | part of the text to use a fixed-width font, you should specify the | |
1904 | @code{fixed} face for that part. | |
1905 | ||
1906 | The @code{fixed} face is normally defined to use a different font from | |
1907 | the default. However, different systems have different fonts installed, | |
1908 | so you may need to customize this. | |
1909 | ||
1910 | If your terminal cannot display different faces, you will not be able | |
1911 | to see them, but you can still edit documents containing faces. You can | |
1912 | even add faces and colors to documents. They will be visible when the | |
1913 | file is viewed on a terminal that can display them. | |
1914 | ||
1915 | @node Format Colors | |
1916 | @subsection Colors in Formatted Text | |
1917 | ||
1918 | You can specify foreground and background colors for portions of the | |
1919 | text. There is a menu for specifying the foreground color and a menu | |
1920 | for specifying the background color. Each color menu lists all the | |
1921 | colors that you have used in Enriched mode in the current Emacs session. | |
1922 | ||
1923 | If you specify a color with a prefix argument---or, in Transient Mark | |
1924 | mode, if the region is not active---then it applies to your next | |
1925 | self-inserting input. @xref{Transient Mark}. Otherwise, the command | |
1926 | applies to the region. | |
1927 | ||
1928 | Each color menu contains one additional item: @samp{Other}. You can use | |
1929 | this item to specify a color that is not listed in the menu; it reads | |
1930 | the color name with the minibuffer. To display list of available colors | |
1931 | and their names, use the @samp{Display Colors} menu item in the Text | |
1932 | Properties menu (@pxref{Editing Format Info}). | |
1933 | ||
1934 | Any color that you specify in this way, or that is mentioned in a | |
1935 | formatted text file that you read in, is added to both color menus for | |
1936 | the duration of the Emacs session. | |
1937 | ||
1938 | @findex facemenu-set-foreground | |
1939 | @findex facemenu-set-background | |
1940 | There are no key bindings for specifying colors, but you can do so | |
1941 | with the extended commands @kbd{M-x facemenu-set-foreground} and | |
1942 | @kbd{M-x facemenu-set-background}. Both of these commands read the name | |
1943 | of the color with the minibuffer. | |
1944 | ||
1945 | @node Format Indentation | |
1946 | @subsection Indentation in Formatted Text | |
1947 | ||
1948 | When editing formatted text, you can specify different amounts of | |
1949 | indentation for the right or left margin of an entire paragraph or a | |
1950 | part of a paragraph. The margins you specify automatically affect the | |
1951 | Emacs fill commands (@pxref{Filling}) and line-breaking commands. | |
1952 | ||
1953 | The Indentation submenu provides a convenient interface for specifying | |
1954 | these properties. The submenu contains four items: | |
1955 | ||
1956 | @table @code | |
1957 | @kindex C-x TAB @r{(Enriched mode)} | |
1958 | @findex increase-left-margin | |
1959 | @item Indent More | |
1960 | Indent the region by 4 columns (@code{increase-left-margin}). In | |
1961 | Enriched mode, this command is also available on @kbd{C-x @key{TAB}}; if | |
1962 | you supply a numeric argument, that says how many columns to add to the | |
1963 | margin (a negative argument reduces the number of columns). | |
1964 | ||
1965 | @item Indent Less | |
1966 | Remove 4 columns of indentation from the region. | |
1967 | ||
1968 | @item Indent Right More | |
1969 | Make the text narrower by indenting 4 columns at the right margin. | |
1970 | ||
1971 | @item Indent Right Less | |
1972 | Remove 4 columns of indentation from the right margin. | |
1973 | @end table | |
1974 | ||
1975 | You can use these commands repeatedly to increase or decrease the | |
1976 | indentation. | |
1977 | ||
1978 | The most common way to use these commands is to change the indentation | |
1979 | of an entire paragraph. However, that is not the only use. You can | |
1980 | change the margins at any point; the new values take effect at the end | |
1981 | of the line (for right margins) or the beginning of the next line (for | |
1982 | left margins). | |
1983 | ||
1984 | This makes it possible to format paragraphs with @dfn{hanging indents}, | |
1985 | which means that the first line is indented less than subsequent lines. | |
1986 | To set up a hanging indent, increase the indentation of the region | |
1987 | starting after the first word of the paragraph and running until the end | |
1988 | of the paragraph. | |
1989 | ||
1990 | Indenting the first line of a paragraph is easier. Set the margin for | |
1991 | the whole paragraph where you want it to be for the body of the | |
1992 | paragraph, then indent the first line by inserting extra spaces or tabs. | |
1993 | ||
1994 | Sometimes, as a result of editing, the filling of a paragraph becomes | |
1995 | messed up---parts of the paragraph may extend past the left or right | |
1996 | margins. When this happens, use @kbd{M-q} (@code{fill-paragraph}) to | |
1997 | refill the paragraph. | |
1998 | ||
1999 | @vindex standard-indent | |
2000 | The variable @code{standard-indent} specifies how many columns these | |
2001 | commands should add to or subtract from the indentation. The default | |
2002 | value is 4. The overall default right margin for Enriched mode is | |
2003 | controlled by the variable @code{fill-column}, as usual. | |
2004 | ||
2005 | The fill prefix, if any, works in addition to the specified paragraph | |
2006 | indentation: @kbd{C-x .} does not include the specified indentation's | |
2007 | whitespace in the new value for the fill prefix, and the fill commands | |
2008 | look for the fill prefix after the indentation on each line. @xref{Fill | |
2009 | Prefix}. | |
2010 | ||
2011 | @node Format Justification | |
2012 | @subsection Justification in Formatted Text | |
2013 | ||
2014 | When editing formatted text, you can specify various styles of | |
2015 | justification for a paragraph. The style you specify automatically | |
2016 | affects the Emacs fill commands. | |
2017 | ||
2018 | The Justification submenu provides a convenient interface for specifying | |
2019 | the style. The submenu contains five items: | |
2020 | ||
2021 | @table @code | |
2022 | @item Flush Left | |
2023 | This is the most common style of justification (at least for English). | |
2024 | Lines are aligned at the left margin but left uneven at the right. | |
2025 | ||
2026 | @item Flush Right | |
2027 | This aligns each line with the right margin. Spaces and tabs are added | |
2028 | on the left, if necessary, to make lines line up on the right. | |
2029 | ||
2030 | @item Full | |
2031 | This justifies the text, aligning both edges of each line. Justified | |
2032 | text looks very nice in a printed book, where the spaces can all be | |
2033 | adjusted equally, but it does not look as nice with a fixed-width font | |
2034 | on the screen. Perhaps a future version of Emacs will be able to adjust | |
2035 | the width of spaces in a line to achieve elegant justification. | |
2036 | ||
2037 | @item Center | |
2038 | This centers every line between the current margins. | |
2039 | ||
2040 | @item None | |
2041 | This turns off filling entirely. Each line will remain as you wrote it; | |
2042 | the fill and auto-fill functions will have no effect on text which has | |
2043 | this setting. You can, however, still indent the left margin. In | |
2044 | unfilled regions, all newlines are treated as hard newlines (@pxref{Hard | |
2045 | and Soft Newlines}) . | |
2046 | @end table | |
2047 | ||
2048 | In Enriched mode, you can also specify justification from the keyboard | |
2049 | using the @kbd{M-j} prefix character: | |
2050 | ||
2051 | @table @kbd | |
2052 | @kindex M-j l @r{(Enriched mode)} | |
2053 | @findex set-justification-left | |
2054 | @item M-j l | |
2055 | Make the region left-filled (@code{set-justification-left}). | |
2056 | @kindex M-j r @r{(Enriched mode)} | |
2057 | @findex set-justification-right | |
2058 | @item M-j r | |
2059 | Make the region right-filled (@code{set-justification-right}). | |
2060 | @kindex M-j f @r{(Enriched mode)} | |
2061 | @findex set-justification-full | |
2062 | @item M-j f | |
2063 | Make the region fully-justified (@code{set-justification-full}). | |
2064 | @kindex M-j c @r{(Enriched mode)} | |
2065 | @kindex M-S @r{(Enriched mode)} | |
2066 | @findex set-justification-center | |
2067 | @item M-j c | |
2068 | @itemx M-S | |
2069 | Make the region centered (@code{set-justification-center}). | |
2070 | @kindex M-j u @r{(Enriched mode)} | |
2071 | @findex set-justification-none | |
2072 | @item M-j u | |
2073 | Make the region unfilled (@code{set-justification-none}). | |
2074 | @end table | |
2075 | ||
2076 | Justification styles apply to entire paragraphs. All the | |
2077 | justification-changing commands operate on the paragraph containing | |
2078 | point, or, if the region is active, on all paragraphs which overlap the | |
2079 | region. | |
2080 | ||
2081 | @vindex default-justification | |
2082 | The default justification style is specified by the variable | |
2083 | @code{default-justification}. Its value should be one of the symbols | |
2084 | @code{left}, @code{right}, @code{full}, @code{center}, or @code{none}. | |
2085 | ||
2086 | @node Format Properties | |
2087 | @subsection Setting Other Text Properties | |
2088 | ||
2089 | The Other Properties menu lets you add or remove three other useful text | |
2090 | properties: @code{read-only}, @code{invisible} and @code{intangible}. | |
2091 | The @code{intangible} property disallows moving point within the text, | |
2092 | the @code{invisible} text property hides text from display, and the | |
2093 | @code{read-only} property disallows alteration of the text. | |
2094 | ||
2095 | Each of these special properties has a menu item to add it to the | |
2096 | region. The last menu item, @samp{Remove Special}, removes all of these | |
2097 | special properties from the text in the region. | |
2098 | ||
2099 | Currently, the @code{invisible} and @code{intangible} properties are | |
2100 | @emph{not} saved in the text/enriched format. The @code{read-only} | |
2101 | property is saved, but it is not a standard part of the text/enriched | |
2102 | format, so other editors may not respect it. | |
2103 | ||
2104 | @node Forcing Enriched Mode | |
2105 | @subsection Forcing Enriched Mode | |
2106 | ||
2107 | Normally, Emacs knows when you are editing formatted text because it | |
2108 | recognizes the special annotations used in the file that you visited. | |
2109 | However, there are situations in which you must take special actions | |
2110 | to convert file contents or turn on Enriched mode: | |
2111 | ||
2112 | @itemize @bullet | |
2113 | @item | |
2114 | When you visit a file that was created with some other editor, Emacs may | |
2115 | not recognize the file as being in the text/enriched format. In this | |
2116 | case, when you visit the file you will see the formatting commands | |
2117 | rather than the formatted text. Type @kbd{M-x format-decode-buffer} to | |
2118 | translate it. | |
2119 | ||
2120 | @item | |
2121 | When you @emph{insert} a file into a buffer, rather than visiting it. | |
2122 | Emacs does the necessary conversions on the text which you insert, but | |
2123 | it does not enable Enriched mode. If you wish to do that, type @kbd{M-x | |
2124 | enriched-mode}. | |
2125 | @end itemize | |
2126 | ||
2127 | The command @code{format-decode-buffer} translates text in various | |
2128 | formats into Emacs's internal format. It asks you to specify the format | |
2129 | to translate from; however, normally you can type just @key{RET}, which | |
2130 | tells Emacs to guess the format. | |
2131 | ||
2132 | @findex format-find-file | |
2133 | If you wish to look at text/enriched file in its raw form, as a | |
2134 | sequence of characters rather than as formatted text, use the @kbd{M-x | |
2135 | find-file-literally} command. This visits a file, like | |
2136 | @code{find-file}, but does not do format conversion. It also inhibits | |
2137 | character code conversion (@pxref{Coding Systems}) and automatic | |
2138 | uncompression (@pxref{Compressed Files}). To disable format conversion | |
2139 | but allow character code conversion and/or automatic uncompression if | |
2140 | appropriate, use @code{format-find-file} with suitable arguments. | |
2141 |