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