(outline-minor-mode): Use define-minor-mode.
[emacs.git] / man / text.texi
blobc2fb149280a7133c1491579c1afd086c87a74893
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
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.
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.
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
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.
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
53   The `automatic typing' features may be useful when writing text.
54 @xref{Top, Autotyping, autotype, Features for Automatic Typing}.
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
70 @node Words
71 @section Words
72 @cindex words
73 @cindex Meta commands and words
75   Emacs has commands for moving over or operating on words.  By convention,
76 the keys for them are all Meta characters.
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
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}}.
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
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}.
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}}.)
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.
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.
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}.
155 @node Sentences
156 @section Sentences
157 @cindex sentences
158 @cindex manipulating sentences
160   The Emacs commands for manipulating sentences and paragraphs are mostly
161 on Meta keys, so as to be like the word-handling commands.
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
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.
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.
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
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.
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
217 @example
218 "[.?!][]\"')]*\\($\\|\t\\|  \\)[ \t\n]*"
219 @end example
221 @noindent
222 This example is explained in the section on regexps.  @xref{Regexps}.
224   If you want to use just one space between sentences, you should
225 set @code{sentence-end} to this value:
227 @example
228 "[.?!][]\"')]*\\($\\|\t\\| \\)[ \t\n]*"
229 @end example
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.
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
247   The Emacs commands for manipulating paragraphs are also Meta keys.
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
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.)
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.
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}.
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.
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
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.
303 @node Pages
304 @section Pages
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.
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
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.
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.
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.
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
363 @example
364 Page has 96 (72+25) lines
365 @end example
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.
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.
377 @node Filling
378 @section Filling Text
379 @cindex filling text
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}).
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
397 @node Auto Fill
398 @subsection Auto Fill Mode
399 @cindex Auto Fill mode
400 @cindex mode, Auto Fill
401 @cindex word wrap
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}.
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
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}.
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.
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}).
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.
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
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}.
455 @node Fill Commands
456 @subsection Explicit Fill Commands
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
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.
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.
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
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}.
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.
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.
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.
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}.
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.
535 @vindex sentence-end-without-period
536 The variable @code{sentence-end-without-period} can be set
537 non-@code{nil} to indicate that a sentence will end without a period.
538 For example, a sentence in Thai text ends with double space but without
539 a period.
541 @node Fill Prefix
542 @subsection The Fill Prefix
544 @cindex fill prefix
545   To fill a paragraph in which each line starts with a special marker
546 (which might be a few spaces, giving an indented paragraph), you can use
547 the @dfn{fill prefix} feature.  The fill prefix is a string that Emacs
548 expects every line to start with, and which is not included in filling.
549 You can specify a fill prefix explicitly; Emacs can also deduce the
550 fill prefix automatically (@pxref{Adaptive Fill}).
552 @table @kbd
553 @item C-x .
554 Set the fill prefix (@code{set-fill-prefix}).
555 @item M-q
556 Fill a paragraph using current fill prefix (@code{fill-paragraph}).
557 @item M-x fill-individual-paragraphs
558 Fill the region, considering each change of indentation as starting a
559 new paragraph.
560 @item M-x fill-nonuniform-paragraphs
561 Fill the region, considering only paragraph-separator lines as starting
562 a new paragraph.
563 @end table
565 @kindex C-x .
566 @findex set-fill-prefix
567   To specify a fill prefix, move to a line that starts with the desired
568 prefix, put point at the end of the prefix, and give the command
569 @w{@kbd{C-x .}}@: (@code{set-fill-prefix}).  That's a period after the
570 @kbd{C-x}.  To turn off the fill prefix, specify an empty prefix: type
571 @w{@kbd{C-x .}}@: with point at the beginning of a line.@refill
573   When a fill prefix is in effect, the fill commands remove the fill
574 prefix from each line before filling and insert it on each line after
575 filling.  Auto Fill mode also inserts the fill prefix automatically when
576 it makes a new line.  The @kbd{C-o} command inserts the fill prefix on
577 new lines it creates, when you use it at the beginning of a line
578 (@pxref{Blank Lines}).  Conversely, the command @kbd{M-^} deletes the
579 prefix (if it occurs) after the newline that it deletes
580 (@pxref{Indentation}).
582   For example, if @code{fill-column} is 40 and you set the fill prefix
583 to @samp{;; }, then @kbd{M-q} in the following text
585 @example
586 ;; This is an
587 ;; example of a paragraph
588 ;; inside a Lisp-style comment.
589 @end example
591 @noindent
592 produces this:
594 @example
595 ;; This is an example of a paragraph
596 ;; inside a Lisp-style comment.
597 @end example
599   Lines that do not start with the fill prefix are considered to start
600 paragraphs, both in @kbd{M-q} and the paragraph commands; this gives
601 good results for paragraphs with hanging indentation (every line
602 indented except the first one).  Lines which are blank or indented once
603 the prefix is removed also separate or start paragraphs; this is what
604 you want if you are writing multi-paragraph comments with a comment
605 delimiter on each line.
607 @findex fill-individual-paragraphs
608   You can use @kbd{M-x fill-individual-paragraphs} to set the fill
609 prefix for each paragraph automatically.  This command divides the
610 region into paragraphs, treating every change in the amount of
611 indentation as the start of a new paragraph, and fills each of these
612 paragraphs.  Thus, all the lines in one ``paragraph'' have the same
613 amount of indentation.  That indentation serves as the fill prefix for
614 that paragraph.
616 @findex fill-nonuniform-paragraphs
617   @kbd{M-x fill-nonuniform-paragraphs} is a similar command that divides
618 the region into paragraphs in a different way.  It considers only
619 paragraph-separating lines (as defined by @code{paragraph-separate}) as
620 starting a new paragraph.  Since this means that the lines of one
621 paragraph may have different amounts of indentation, the fill prefix
622 used is the smallest amount of indentation of any of the lines of the
623 paragraph.  This gives good results with styles that indent a paragraph's
624 first line more or less that the rest of the paragraph.
626 @vindex fill-prefix
627   The fill prefix is stored in the variable @code{fill-prefix}.  Its value
628 is a string, or @code{nil} when there is no fill prefix.  This is a
629 per-buffer variable; altering the variable affects only the current buffer,
630 but there is a default value which you can change as well.  @xref{Locals}.
632   The @code{indentation} text property provides another way to control
633 the amount of indentation paragraphs receive.  @xref{Format Indentation}.
635 @node Adaptive Fill
636 @subsection Adaptive Filling
638 @cindex adaptive filling
639   The fill commands can deduce the proper fill prefix for a paragraph
640 automatically in certain cases: either whitespace or certain punctuation
641 characters at the beginning of a line are propagated to all lines of the
642 paragraph.
644   If the paragraph has two or more lines, the fill prefix is taken from
645 the paragraph's second line, but only if it appears on the first line as
646 well.
648   If a paragraph has just one line, fill commands @emph{may} take a
649 prefix from that line.  The decision is complicated because there are
650 three reasonable things to do in such a case:
652 @itemize @bullet
653 @item
654 Use the first line's prefix on all the lines of the paragraph.
656 @item
657 Indent subsequent lines with whitespace, so that they line up under the
658 text that follows the prefix on the first line, but don't actually copy
659 the prefix from the first line.
661 @item
662 Don't do anything special with the second and following lines.
663 @end itemize
665   All three of these styles of formatting are commonly used.  So the
666 fill commands try to determine what you would like, based on the prefix
667 that appears and on the major mode.  Here is how.
669 @vindex adaptive-fill-first-line-regexp
670   If the prefix found on the first line matches
671 @code{adaptive-fill-first-line-regexp}, or if it appears to be a
672 comment-starting sequence (this depends on the major mode), then the
673 prefix found is used for filling the paragraph, provided it would not
674 act as a paragraph starter on subsequent lines.
676   Otherwise, the prefix found is converted to an equivalent number of
677 spaces, and those spaces are used as the fill prefix for the rest of the
678 lines, provided they would not act as a paragraph starter on subsequent
679 lines.
681   In Text mode, and other modes where only blank lines and page
682 delimiters separate paragraphs, the prefix chosen by adaptive filling
683 never acts as a paragraph starter, so it can always be used for filling.
685 @vindex adaptive-fill-mode
686 @vindex adaptive-fill-regexp
687   The variable @code{adaptive-fill-regexp} determines what kinds of line
688 beginnings can serve as a fill prefix: any characters at the start of
689 the line that match this regular expression are used.  If you set the
690 variable @code{adaptive-fill-mode} to @code{nil}, the fill prefix is
691 never chosen automatically.
693 @vindex adaptive-fill-function
694   You can specify more complex ways of choosing a fill prefix
695 automatically by setting the variable @code{adaptive-fill-function} to a
696 function.  This function is called with point after the left margin of a
697 line, and it should return the appropriate fill prefix based on that
698 line.  If it returns @code{nil}, that means it sees no fill prefix in
699 that line.
701 @node Case
702 @section Case Conversion Commands
703 @cindex case conversion
705   Emacs has commands for converting either a single word or any arbitrary
706 range of text to upper case or to lower case.
708 @c WideCommands
709 @table @kbd
710 @item M-l
711 Convert following word to lower case (@code{downcase-word}).
712 @item M-u
713 Convert following word to upper case (@code{upcase-word}).
714 @item M-c
715 Capitalize the following word (@code{capitalize-word}).
716 @item C-x C-l
717 Convert region to lower case (@code{downcase-region}).
718 @item C-x C-u
719 Convert region to upper case (@code{upcase-region}).
720 @end table
722 @kindex M-l
723 @kindex M-u
724 @kindex M-c
725 @cindex words, case conversion
726 @cindex converting text to upper or lower case
727 @cindex capitalizing words
728 @findex downcase-word
729 @findex upcase-word
730 @findex capitalize-word
731   The word conversion commands are the most useful.  @kbd{M-l}
732 (@code{downcase-word}) converts the word after point to lower case, moving
733 past it.  Thus, repeating @kbd{M-l} converts successive words.
734 @kbd{M-u} (@code{upcase-word}) converts to all capitals instead, while
735 @kbd{M-c} (@code{capitalize-word}) puts the first letter of the word
736 into upper case and the rest into lower case.  All these commands convert
737 several words at once if given an argument.  They are especially convenient
738 for converting a large amount of text from all upper case to mixed case,
739 because you can move through the text using @kbd{M-l}, @kbd{M-u} or
740 @kbd{M-c} on each word as appropriate, occasionally using @kbd{M-f} instead
741 to skip a word.
743   When given a negative argument, the word case conversion commands apply
744 to the appropriate number of words before point, but do not move point.
745 This is convenient when you have just typed a word in the wrong case: you
746 can give the case conversion command and continue typing.
748   If a word case conversion command is given in the middle of a word, it
749 applies only to the part of the word which follows point.  This is just
750 like what @kbd{M-d} (@code{kill-word}) does.  With a negative argument,
751 case conversion applies only to the part of the word before point.
753 @kindex C-x C-l
754 @kindex C-x C-u
755 @findex downcase-region
756 @findex upcase-region
757   The other case conversion commands are @kbd{C-x C-u}
758 (@code{upcase-region}) and @kbd{C-x C-l} (@code{downcase-region}), which
759 convert everything between point and mark to the specified case.  Point and
760 mark do not move.
762   The region case conversion commands @code{upcase-region} and
763 @code{downcase-region} are normally disabled.  This means that they ask
764 for confirmation if you try to use them.  When you confirm, you may
765 enable the command, which means it will not ask for confirmation again.
766 @xref{Disabling}.
768 @node Text Mode
769 @section Text Mode
770 @cindex Text mode
771 @cindex mode, Text
772 @findex text-mode
774   When you edit files of text in a human language, it's more convenient
775 to use Text mode rather than Fundamental mode.  To enter Text mode, type
776 @kbd{M-x text-mode}.
778   In Text mode, only blank lines and page delimiters separate
779 paragraphs.  As a result, paragraphs can be indented, and adaptive
780 filling determines what indentation to use when filling a paragraph.
781 @xref{Adaptive Fill}.
783 @kindex TAB @r{(Text mode)}
784   Text mode defines @key{TAB} to run @code{indent-relative}
785 (@pxref{Indentation}), so that you can conveniently indent a line like
786 the previous line.  When the previous line is not indented,
787 @code{indent-relative} runs @code{tab-to-tab-stop}, which uses Emacs tab
788 stops that you can set (@pxref{Tab Stops}).
790   Text mode turns off the features concerned with comments except when
791 you explicitly invoke them.  It changes the syntax table so that periods
792 are not considered part of a word, while apostrophes, backspaces and
793 underlines are considered part of words.
795 @cindex Paragraph-Indent Text mode
796 @cindex mode, Paragraph-Indent Text
797 @findex paragraph-indent-text-mode
798 @findex paragraph-indent-minor-mode
799   If you indent the first lines of paragraphs, then you should use
800 Paragraph-Indent Text mode rather than Text mode.  In this mode, you do
801 not need to have blank lines between paragraphs, because the first-line
802 indentation is sufficient to start a paragraph; however paragraphs in
803 which every line is indented are not supported.  Use @kbd{M-x
804 paragraph-indent-text-mode} to enter this mode.  Use @kbd{M-x
805 paragraph-indent-minor-mode} to enter an equivalent minor mode, for
806 instance during mail composition.
808 @kindex M-TAB @r{(Text mode)}
809   Text mode, and all the modes based on it, define @kbd{M-@key{TAB}} as
810 the command @code{ispell-complete-word}, which performs completion of
811 the partial word in the buffer before point, using the spelling
812 dictionary as the space of possible words.  @xref{Spelling}.
814 @vindex text-mode-hook
815   Entering Text mode runs the hook @code{text-mode-hook}.  Other major
816 modes related to Text mode also run this hook, followed by hooks of
817 their own; this includes Paragraph-Indent Text mode, Nroff mode, @TeX{}
818 mode, Outline mode, and Mail mode.  Hook functions on
819 @code{text-mode-hook} can look at the value of @code{major-mode} to see
820 which of these modes is actually being entered.  @xref{Hooks}.
822 @ifinfo
823   Emacs provides two other modes for editing text that is to be passed
824 through a text formatter to produce fancy formatted printed output.
825 @xref{Nroff Mode}, for editing input to the formatter nroff.
826 @xref{TeX Mode}, for editing input to the formatter TeX.
828   Another mode is used for editing outlines.  It allows you to view the
829 text at various levels of detail.  You can view either the outline
830 headings alone or both headings and text; you can also hide some of the
831 headings at lower levels from view to make the high level structure more
832 visible.  @xref{Outline Mode}.
833 @end ifinfo
835 @node Outline Mode
836 @section Outline Mode
837 @cindex Outline mode
838 @cindex mode, Outline
839 @cindex selective display
840 @cindex invisible lines
842 @findex outline-mode
843 @findex outline-minor-mode
844 @vindex outline-minor-mode-prefix
845   Outline mode is a major mode much like Text mode but intended for
846 editing outlines.  It allows you to make parts of the text temporarily
847 invisible so that you can see the outline structure.  Type @kbd{M-x
848 outline-mode} to switch to Outline mode as the major mode of the current
849 buffer.
851   When Outline mode makes a line invisible, the line does not appear on
852 the screen.  The screen appears exactly as if the invisible line were
853 deleted, except that an ellipsis (three periods in a row) appears at the
854 end of the previous visible line (only one ellipsis no matter how many
855 invisible lines follow).
857   Editing commands that operate on lines, such as @kbd{C-n} and
858 @kbd{C-p}, treat the text of the invisible line as part of the previous
859 visible line.  Killing an entire visible line, including its terminating
860 newline, really kills all the following invisible lines along with it.
862   Outline minor mode provides the same commands as the major mode,
863 Outline mode, but you can use it in conjunction with other major modes.
864 Type @kbd{M-x outline-minor-mode} to enable the Outline minor mode in
865 the current buffer.  You can also specify this in the text of a file,
866 with a file local variable of the form @samp{mode: outline-minor}
867 (@pxref{File Variables}).
869 @kindex C-c @@ @r{(Outline minor mode)}
870   The major mode, Outline mode, provides special key bindings on the
871 @kbd{C-c} prefix.  Outline minor mode provides similar bindings with
872 @kbd{C-c @@} as the prefix; this is to reduce the conflicts with the
873 major mode's special commands.  (The variable
874 @code{outline-minor-mode-prefix} controls the prefix used.)
876 @vindex outline-mode-hook
877   Entering Outline mode runs the hook @code{text-mode-hook} followed by
878 the hook @code{outline-mode-hook} (@pxref{Hooks}).
880 @menu
881 * Format: Outline Format.          What the text of an outline looks like.
882 * Motion: Outline Motion.          Special commands for moving through
883                                      outlines. 
884 * Visibility: Outline Visibility.  Commands to control what is visible.
885 * Views: Outline Views.            Outlines and multiple views.
886 * Foldout::                        Folding editing.
887 @end menu
889 @node Outline Format
890 @subsection Format of Outlines
892 @cindex heading lines (Outline mode)
893 @cindex body lines (Outline mode)
894   Outline mode assumes that the lines in the buffer are of two types:
895 @dfn{heading lines} and @dfn{body lines}.  A heading line represents a
896 topic in the outline.  Heading lines start with one or more stars; the
897 number of stars determines the depth of the heading in the outline
898 structure.  Thus, a heading line with one star is a major topic; all the
899 heading lines with two stars between it and the next one-star heading
900 are its subtopics; and so on.  Any line that is not a heading line is a
901 body line.  Body lines belong with the preceding heading line.  Here is
902 an example:
904 @example
905 * Food
906 This is the body,
907 which says something about the topic of food.
909 ** Delicious Food
910 This is the body of the second-level header.
912 ** Distasteful Food
913 This could have
914 a body too, with
915 several lines.
917 *** Dormitory Food
919 * Shelter
920 Another first-level topic with its header line.
921 @end example
923   A heading line together with all following body lines is called
924 collectively an @dfn{entry}.  A heading line together with all following
925 deeper heading lines and their body lines is called a @dfn{subtree}.
927 @vindex outline-regexp
928   You can customize the criterion for distinguishing heading lines
929 by setting the variable @code{outline-regexp}.  Any line whose
930 beginning has a match for this regexp is considered a heading line.
931 Matches that start within a line (not at the left margin) do not count.
932 The length of the matching text determines the level of the heading;
933 longer matches make a more deeply nested level.  Thus, for example,
934 if a text formatter has commands @samp{@@chapter}, @samp{@@section}
935 and @samp{@@subsection} to divide the document into chapters and
936 sections, you could make those lines count as heading lines by
937 setting @code{outline-regexp} to @samp{"@@chap\\|@@\\(sub\\)*section"}.
938 Note the trick: the two words @samp{chapter} and @samp{section} are equally
939 long, but by defining the regexp to match only @samp{chap} we ensure
940 that the length of the text matched on a chapter heading is shorter,
941 so that Outline mode will know that sections are contained in chapters.
942 This works as long as no other command starts with @samp{@@chap}.
944 @vindex outline-level
945   It is possible to change the rule for calculating the level of a
946 heading line by setting the variable @code{outline-level}.  The value of
947 @code{outline-level} should be a function that takes no arguments and
948 returns the level of the current heading.  Some major modes such as C,
949 Nroff, and Emacs Lisp mode set this variable and/or
950 @code{outline-regexp} in order to work with Outline minor mode.
952 @node Outline Motion
953 @subsection Outline Motion Commands
955   Outline mode provides special motion commands that move backward and
956 forward to heading lines.
958 @table @kbd
959 @item C-c C-n
960 Move point to the next visible heading line
961 (@code{outline-next-visible-heading}).
962 @item C-c C-p
963 Move point to the previous visible heading line
964 (@code{outline-previous-visible-heading}).
965 @item C-c C-f
966 Move point to the next visible heading line at the same level
967 as the one point is on (@code{outline-forward-same-level}).
968 @item C-c C-b
969 Move point to the previous visible heading line at the same level
970 (@code{outline-backward-same-level}).
971 @item C-c C-u
972 Move point up to a lower-level (more inclusive) visible heading line
973 (@code{outline-up-heading}).
974 @end table
976 @findex outline-next-visible-heading
977 @findex outline-previous-visible-heading
978 @kindex C-c C-n @r{(Outline mode)}
979 @kindex C-c C-p @r{(Outline mode)}
980   @kbd{C-c C-n} (@code{outline-next-visible-heading}) moves down to the next
981 heading line.  @kbd{C-c C-p} (@code{outline-previous-visible-heading}) moves
982 similarly backward.  Both accept numeric arguments as repeat counts.  The
983 names emphasize that invisible headings are skipped, but this is not really
984 a special feature.  All editing commands that look for lines ignore the
985 invisible lines automatically.@refill
987 @findex outline-up-heading
988 @findex outline-forward-same-level
989 @findex outline-backward-same-level
990 @kindex C-c C-f @r{(Outline mode)}
991 @kindex C-c C-b @r{(Outline mode)}
992 @kindex C-c C-u @r{(Outline mode)}
993   More powerful motion commands understand the level structure of headings.
994 @kbd{C-c C-f} (@code{outline-forward-same-level}) and
995 @kbd{C-c C-b} (@code{outline-backward-same-level}) move from one
996 heading line to another visible heading at the same depth in
997 the outline.  @kbd{C-c C-u} (@code{outline-up-heading}) moves
998 backward to another heading that is less deeply nested.
1000 @node Outline Visibility
1001 @subsection Outline Visibility Commands
1003   The other special commands of outline mode are used to make lines visible
1004 or invisible.  Their names all start with @code{hide} or @code{show}.
1005 Most of them fall into pairs of opposites.  They are not undoable; instead,
1006 you can undo right past them.  Making lines visible or invisible is simply
1007 not recorded by the undo mechanism.
1009 @table @kbd
1010 @item C-c C-t
1011 Make all body lines in the buffer invisible (@code{hide-body}).
1012 @item C-c C-a
1013 Make all lines in the buffer visible (@code{show-all}).
1014 @item C-c C-d
1015 Make everything under this heading invisible, not including this
1016 heading itself (@code{hide-subtree}).
1017 @item C-c C-s
1018 Make everything under this heading visible, including body,
1019 subheadings, and their bodies (@code{show-subtree}).
1020 @item C-c C-l
1021 Make the body of this heading line, and of all its subheadings,
1022 invisible (@code{hide-leaves}).
1023 @item C-c C-k
1024 Make all subheadings of this heading line, at all levels, visible
1025 (@code{show-branches}). 
1026 @item C-c C-i
1027 Make immediate subheadings (one level down) of this heading line
1028 visible (@code{show-children}).
1029 @item C-c C-c
1030 Make this heading line's body invisible (@code{hide-entry}).
1031 @item C-c C-e
1032 Make this heading line's body visible (@code{show-entry}).
1033 @item C-c C-q
1034 Hide everything except the top @var{n} levels of heading lines
1035 (@code{hide-sublevels}).
1036 @item C-c C-o
1037 Hide everything except for the heading or body that point is in, plus
1038 the headings leading up from there to the top level of the outline
1039 (@code{hide-other}).
1040 @end table
1042 @findex hide-entry
1043 @findex show-entry
1044 @kindex C-c C-c @r{(Outline mode)}
1045 @kindex C-c C-e @r{(Outline mode)}
1046   Two commands that are exact opposites are @kbd{C-c C-c}
1047 (@code{hide-entry}) and @kbd{C-c C-e} (@code{show-entry}).  They are
1048 used with point on a heading line, and apply only to the body lines of
1049 that heading.  Subheadings and their bodies are not affected.
1051 @findex hide-subtree
1052 @findex show-subtree
1053 @kindex C-c C-s @r{(Outline mode)}
1054 @kindex C-c C-d @r{(Outline mode)}
1055 @cindex subtree (Outline mode)
1056   Two more powerful opposites are @kbd{C-c C-d} (@code{hide-subtree}) and
1057 @kbd{C-c C-s} (@code{show-subtree}).  Both expect to be used when point is
1058 on a heading line, and both apply to all the lines of that heading's
1059 @dfn{subtree}: its body, all its subheadings, both direct and indirect, and
1060 all of their bodies.  In other words, the subtree contains everything
1061 following this heading line, up to and not including the next heading of
1062 the same or higher rank.@refill
1064 @findex hide-leaves
1065 @findex show-branches
1066 @kindex C-c C-l @r{(Outline mode)}
1067 @kindex C-c C-k @r{(Outline mode)}
1068   Intermediate between a visible subtree and an invisible one is having
1069 all the subheadings visible but none of the body.  There are two
1070 commands for doing this, depending on whether you want to hide the
1071 bodies or make the subheadings visible.  They are @kbd{C-c C-l}
1072 (@code{hide-leaves}) and @kbd{C-c C-k} (@code{show-branches}).
1074 @kindex C-c C-i @r{(Outline mode)}
1075 @findex show-children
1076   A little weaker than @code{show-branches} is @kbd{C-c C-i}
1077 (@code{show-children}).  It makes just the direct subheadings
1078 visible---those one level down.  Deeper subheadings remain invisible, if
1079 they were invisible.@refill
1081 @findex hide-body
1082 @findex show-all
1083 @kindex C-c C-t @r{(Outline mode)}
1084 @kindex C-c C-a @r{(Outline mode)}
1085   Two commands have a blanket effect on the whole file.  @kbd{C-c C-t}
1086 (@code{hide-body}) makes all body lines invisible, so that you see just
1087 the outline structure.  @kbd{C-c C-a} (@code{show-all}) makes all lines
1088 visible.  These commands can be thought of as a pair of opposites even
1089 though @kbd{C-c C-a} applies to more than just body lines.
1091 @findex hide-sublevels
1092 @kindex C-c C-q @r{(Outline mode)}
1093   The command @kbd{C-c C-q} (@code{hide-sublevels}) hides all but the
1094 top level headings.  With a numeric argument @var{n}, it hides everything
1095 except the top @var{n} levels of heading lines.
1097 @findex hide-other
1098 @kindex C-c C-o @r{(Outline mode)}
1099   The command @kbd{C-c C-o} (@code{hide-other}) hides everything except
1100 the heading or body text that point is in, plus its parents (the headers
1101 leading up from there to top level in the outline).
1103   You can turn off the use of ellipses at the ends of visible lines by
1104 setting @code{selective-display-ellipses} to @code{nil}.  Then there is
1105 no visible indication of the presence of invisible lines.
1107   When incremental search finds text that is hidden by Outline mode,
1108 it makes that part of the buffer visible.  If you exit the search
1109 at that position, the text remains visible.
1111 @node Outline Views
1112 @subsection Viewing One Outline in Multiple Views
1114 @cindex multiple views of outline
1115 @cindex views of an outline
1116 @cindex outline with multiple views
1117 @cindex indirect buffers and outlines
1118   You can display two views of a single outline at the same time, in
1119 different windows.  To do this, you must create an indirect buffer using
1120 @kbd{M-x make-indirect-buffer}.  The first argument of this command is
1121 the existing outline buffer name, and its second argument is the name to
1122 use for the new indirect buffer.  @xref{Indirect Buffers}.
1124   Once the indirect buffer exists, you can display it in a window in the
1125 normal fashion, with @kbd{C-x 4 b} or other Emacs commands.  The Outline
1126 mode commands to show and hide parts of the text operate on each buffer
1127 independently; as a result, each buffer can have its own view.  If you
1128 want more than two views on the same outline, create additional indirect
1129 buffers.
1131 @node Foldout
1132 @subsection Folding editing
1134 @cindex folding editing
1135 The Foldout package provides folding editor extensions for Outline mode
1136 and Outline minor mode.  It may be used by putting in your @file{.emacs}
1138 @example
1139 (eval-after-load "outline" '(require 'foldout))
1140 @end example
1142 @noindent
1143 Folding editing works as follows.
1145 Consider an Outline mode buffer all the text and subheadings under
1146 level-1 headings hidden.  To look at what is hidden under one of these
1147 headings normally you would use @kbd{C-c C-e} (@kbd{M-x show-entry}) to
1148 expose the body or @kbd{C-c C-i} to expose the child (level-2) headings.
1150 @kindex C-c C-z
1151 @findex foldout-zoom-subtree
1152 With Foldout, you use @kbd{C-c C-z} (@kbd{M-x foldout-zoom-subtree}).
1153 This exposes the body and child subheadings and narrows the buffer so
1154 that only the level-1 heading, the body and the level-2 headings are
1155 visible.  Now to look under one of the level-2 headings, position the
1156 cursor on it and use @kbd{C-c C-z} again.  This exposes the level-2 body
1157 and its level-3 child subheadings and narrows the buffer again.  Zooming
1158 in on successive subheadings can be done as much as you like.  A string
1159 in the modeline shows how deep you've gone.
1161 When zooming in on a heading, to see only the child subheadings specify
1162 a numeric argument: @kbd{C-u C-c C-z}.  The number of levels of children
1163 can be specified too (compare @kbd{M-x show-children}), e.g.@: @kbd{M-2
1164 C-c C-z} exposes two levels of child subheadings.  Alternatively, the
1165 body can be spcified with a negative argument: @kbd{M-- C-c C-z}.  The
1166 whole subtree can be expanded, similarly to @kbd{C-c C-s} (@kbd{M-x
1167 show-subtree}), by specifying a zero argument: @kbd{M-0 C-c C-z}.
1169 While you're zoomed in you can still use outline-mode's exposure and
1170 hiding functions without disturbing Foldout.  Also, since the buffer is
1171 narrowed, `global' editing actions will only affect text under the
1172 zoomed-in heading.  This is useful for restricting changes to a
1173 particular chapter or section of your document.
1175 @kindex C-c C-x
1176 @findex foldout-exit-fold
1177 Unzoom (exit) a fold using @kbd{C-c C-x} (@kbd{M-x foldout-exit-fold}).
1178 This hides all the text and subheadings under the top-level heading and
1179 returns you to the previous view of the buffer.  Specifying a numeric
1180 argument exits that many folds.  Specifying a zero argument exits all
1181 folds.
1183 You might want to exit a fold without hiding the text and subheadings,
1184 specify a negative argument.  For example, @kbd{M--2 C-c C-x} exits two
1185 folds and leaves the text and subheadings exposed.
1187 Foldout provides mouse bindings for entering and exiting folds and for
1188 showing and hiding text as follows:
1189 @table @asis
1190 @item @kbd{M-C-mouse-1} zooms in on the heading clicked on
1191 @table @asis
1192 @item single click
1193 expose body
1194 @item double click
1195 expose subheadings
1196 @item triple click
1197 expose body and subheadings
1198 @item quad click
1199 expose entire subtree
1200 @end table
1201 @item @kbd{M-C-mouse-2} exposes text under the heading clicked on
1202 @table @r
1203 @item single click
1204 expose body
1205 @item double click
1206 expose subheadings
1207 @item triple click
1208 expose body and subheadings
1209 @item quad click
1210 expose entire subtree
1211 @end table
1212 @item @kbd{M-C-mouse-3} hides text under the heading clicked on or exits fold
1213 @table @r
1214 @item single click
1215 hide subtree
1216 @item double click
1217 exit fold and hide text
1218 @item triple click
1219 exit fold without hiding text
1220 @item quad click
1221 exit all folds and hide text
1222 @end table
1223 @end table
1225 @vindex foldout-mouse-modifiers
1226 You can change the modifier keys used by setting
1227 @code{foldout-mouse-modifiers}.
1229 @node TeX Mode, Nroff Mode, Outline Mode, Text
1230 @section @TeX{} Mode
1231 @cindex @TeX{} mode
1232 @cindex La@TeX{} mode
1233 @cindex Sli@TeX{} mode
1234 @cindex mode, @TeX{}
1235 @cindex mode, La@TeX{}
1236 @cindex mode, Sli@TeX{}
1237 @findex tex-mode
1238 @findex plain-tex-mode
1239 @findex latex-mode
1240 @findex slitex-mode
1242   @TeX{} is a powerful text formatter written by Donald Knuth; it is also
1243 free, like GNU Emacs.  La@TeX{} is a simplified input format for @TeX{},
1244 implemented by @TeX{} macros; it comes with @TeX{}.  Sli@TeX{} is a special
1245 form of La@TeX{}.@footnote{Sli@TeX{} is obsoleted by the @samp{slides}
1246 document class in recent La@TeX{} versions.}
1248   Emacs has a special @TeX{} mode for editing @TeX{} input files.
1249 It provides facilities for checking the balance of delimiters and for
1250 invoking @TeX{} on all or part of the file.
1252 @vindex tex-default-mode
1253   @TeX{} mode has three variants, Plain @TeX{} mode, La@TeX{} mode, and
1254 Sli@TeX{} mode (these three distinct major modes differ only slightly).
1255 They are designed for editing the three different formats.  The command
1256 @kbd{M-x tex-mode} looks at the contents of the buffer to determine
1257 whether the contents appear to be either La@TeX{} input or Sli@TeX{}
1258 input; if so, it selects the appropriate mode.  If the file contents do
1259 not appear to be La@TeX{} or Sli@TeX{}, it selects Plain @TeX{} mode.
1260 If the contents are insufficient to determine this, the variable
1261 @code{tex-default-mode} controls which mode is used.
1263   When @kbd{M-x tex-mode} does not guess right, you can use the commands
1264 @kbd{M-x plain-tex-mode}, @kbd{M-x latex-mode}, and @kbd{M-x
1265 slitex-mode} to select explicitly the particular variants of @TeX{}
1266 mode.
1268 @vindex tex-shell-hook
1269 @vindex tex-mode-hook
1270 @vindex latex-mode-hook
1271 @vindex slitex-mode-hook
1272 @vindex plain-tex-mode-hook
1273   Entering any kind of @TeX{} mode runs the hooks @code{text-mode-hook}
1274 and @code{tex-mode-hook}.  Then it runs either
1275 @code{plain-tex-mode-hook} or @code{latex-mode-hook}, whichever is
1276 appropriate.  For Sli@TeX{} files, it calls @code{slitex-mode-hook}.
1277 Starting the @TeX{} shell runs the hook @code{tex-shell-hook}.
1278 @xref{Hooks}.
1280 @findex iso-iso2tex
1281 @findex iso-tex2iso
1282 @findex iso-iso2gtex
1283 @findex iso-gtex2iso
1284 @cindex Latin-1 @TeX{} encoding
1285 @TeX{} encoding
1286 @vindex format-alist
1287 @findex format-find-file
1288 The commands @kbd{M-x iso-iso2tex}, @kbd{M-x iso-tex2iso}, @kbd{M-x
1289 iso-iso2gtex} and @kbd{M-x iso-gtex2iso} can be used to convert between
1290 Latin-1 encoded files and @TeX{}-encoded equivalents.  They are included
1291 by default in the @code{format-alist} variable, and so an be used with
1292 @kbd{M-x format-find-file}, for instance.
1294 @findex tildify-buffer
1295 @findex tildify-region
1296 @cindex ties, @TeX{}, inserting
1297 @cindex hard spaces, @TeX{}, inserting
1298 @cindex SGML
1299 @cindex HTML
1300 The commands @kbd{M-x tildify-buffer} and @kbd{M-x tildify-region} can
1301 be used to insert missing @samp{~} @dfn{tie} characters which should be
1302 present in the file to represent `hard spaces'.  This is set up for
1303 Czech---customize the group @samp{tildify} for other languages or for
1304 other sorts of markup; there is support for SGML (HTML).
1306 @cindex RefTeX package
1307 @cindex references, La@TeX{}
1308 @cindex La@TeX{} references
1309   For managing all kinds of references for La@TeX{}, you can use
1310 Ref@TeX{}.  @xref{Top, , RefTeX, reftex}.
1312 @cindex Bib@TeX{} mode
1313 @cindex mode, Bib@TeX{}
1314 @pindex bibtex
1315 @findex bibtex-mode
1316 There is also a mode for editing files for the Bib@TeX{} bibliography
1317 program often used with La@TeX{}.
1319 @menu
1320 * Editing: TeX Editing.   Special commands for editing in TeX mode.
1321 * LaTeX: LaTeX Editing.   Additional commands for LaTeX input files.
1322 * Printing: TeX Print.    Commands for printing part of a file with TeX.
1323 @end menu
1325 @node TeX Editing
1326 @subsection @TeX{} Editing Commands
1328   Here are the special commands provided in @TeX{} mode for editing the
1329 text of the file.
1331 @table @kbd
1332 @item "
1333 Insert, according to context, either @samp{``} or @samp{"} or
1334 @samp{''} (@code{tex-insert-quote}).
1335 @item C-j
1336 Insert a paragraph break (two newlines) and check the previous
1337 paragraph for unbalanced braces or dollar signs
1338 (@code{tex-terminate-paragraph}).
1339 @item M-x tex-validate-region
1340 Check each paragraph in the region for unbalanced braces or dollar signs.
1341 @item C-c @{
1342 Insert @samp{@{@}} and position point between them (@code{tex-insert-braces}).
1343 @item C-c @}
1344 Move forward past the next unmatched close brace (@code{up-list}).
1345 @end table
1347 @findex tex-insert-quote
1348 @kindex " @r{(@TeX{} mode)}
1349   In @TeX{}, the character @samp{"} is not normally used; we use
1350 @samp{``} to start a quotation and @samp{''} to end one.  To make
1351 editing easier under this formatting convention, @TeX{} mode overrides
1352 the normal meaning of the key @kbd{"} with a command that inserts a pair
1353 of single-quotes or backquotes (@code{tex-insert-quote}).  To be
1354 precise, this command inserts @samp{``} after whitespace or an open
1355 brace, @samp{"} after a backslash, and @samp{''} after any other
1356 character.
1358   If you need the character @samp{"} itself in unusual contexts, use
1359 @kbd{C-q} to insert it.  Also, @kbd{"} with a numeric argument always
1360 inserts that number of @samp{"} characters.  You can turn off the
1361 feature of @kbd{"} expansion by eliminating that binding in the local
1362 map (@pxref{Key Bindings}).
1364   In @TeX{} mode, @samp{$} has a special syntax code which attempts to
1365 understand the way @TeX{} math mode delimiters match.  When you insert a
1366 @samp{$} that is meant to exit math mode, the position of the matching
1367 @samp{$} that entered math mode is displayed for a second.  This is the
1368 same feature that displays the open brace that matches a close brace that
1369 is inserted.  However, there is no way to tell whether a @samp{$} enters
1370 math mode or leaves it; so when you insert a @samp{$} that enters math
1371 mode, the previous @samp{$} position is shown as if it were a match, even
1372 though they are actually unrelated.
1374 @findex tex-insert-braces
1375 @kindex C-c @{ @r{(@TeX{} mode)}
1376 @findex up-list
1377 @kindex C-c @} @r{(@TeX{} mode)}
1378   @TeX{} uses braces as delimiters that must match.  Some users prefer
1379 to keep braces balanced at all times, rather than inserting them
1380 singly.  Use @kbd{C-c @{} (@code{tex-insert-braces}) to insert a pair of
1381 braces.  It leaves point between the two braces so you can insert the
1382 text that belongs inside.  Afterward, use the command @kbd{C-c @}}
1383 (@code{up-list}) to move forward past the close brace.
1385 @findex tex-validate-region
1386 @findex tex-terminate-paragraph
1387 @kindex C-j @r{(@TeX{} mode)}
1388   There are two commands for checking the matching of braces.  @kbd{C-j}
1389 (@code{tex-terminate-paragraph}) checks the paragraph before point, and
1390 inserts two newlines to start a new paragraph.  It prints a message in
1391 the echo area if any mismatch is found.  @kbd{M-x tex-validate-region}
1392 checks a region, paragraph by paragraph.  The errors are listed in the
1393 @samp{*Occur*} buffer, and you can use @kbd{C-c C-c} or @kbd{Mouse-2} in
1394 that buffer to go to a particular mismatch.
1396   Note that Emacs commands count square brackets and parentheses in
1397 @TeX{} mode, not just braces.  This is not strictly correct for the
1398 purpose of checking @TeX{} syntax.  However, parentheses and square
1399 brackets are likely to be used in text as matching delimiters and it is
1400 useful for the various motion commands and automatic match display to
1401 work with them.
1403 @node LaTeX Editing
1404 @subsection La@TeX{} Editing Commands
1406   La@TeX{} mode, and its variant, Sli@TeX{} mode, provide a few extra
1407 features not applicable to plain @TeX{}.
1409 @table @kbd
1410 @item C-c C-o
1411 Insert @samp{\begin} and @samp{\end} for La@TeX{} block and position
1412 point on a line between them (@code{tex-latex-block}).
1413 @item C-c C-e
1414 Close the innermost La@TeX{} block not yet closed
1415 (@code{tex-close-latex-block}).
1416 @end table
1418 @findex tex-latex-block
1419 @kindex C-c C-o @r{(La@TeX{} mode)}
1420 @vindex latex-block-names
1421   In La@TeX{} input, @samp{\begin} and @samp{\end} commands are used to
1422 group blocks of text.  To insert a @samp{\begin} and a matching
1423 @samp{\end} (on a new line following the @samp{\begin}), use @kbd{C-c
1424 C-o} (@code{tex-latex-block}).  A blank line is inserted between the
1425 two, and point is left there.  You can use completion when you enter the
1426 block type; to specify additional block type names beyond the standard
1427 list, set the variable @code{latex-block-names}.  For example, here's
1428 how to add @samp{theorem}, @samp{corollary}, and @samp{proof}:
1430 @example
1431 (setq latex-block-names '("theorem" "corollary" "proof"))
1432 @end example
1434 @findex tex-close-latex-block
1435 @kindex C-c C-e @r{(La@TeX{} mode)}
1436   In La@TeX{} input, @samp{\begin} and @samp{\end} commands must
1437 balance.  You can use @kbd{C-c C-e} (@code{tex-close-latex-block}) to
1438 insert automatically a matching @samp{\end} to match the last unmatched
1439 @samp{\begin}.  It indents the @samp{\end} to match the corresponding
1440 @samp{\begin}.  It inserts a newline after @samp{\end} if point is at
1441 the beginning of a line.
1443 @node TeX Print
1444 @subsection @TeX{} Printing Commands
1446   You can invoke @TeX{} as an inferior of Emacs on either the entire
1447 contents of the buffer or just a region at a time.  Running @TeX{} in
1448 this way on just one chapter is a good way to see what your changes
1449 look like without taking the time to format the entire file.
1451 @table @kbd
1452 @item C-c C-r
1453 Invoke @TeX{} on the current region, together with the buffer's header
1454 (@code{tex-region}).
1455 @item C-c C-b
1456 Invoke @TeX{} on the entire current buffer (@code{tex-buffer}).
1457 @item C-c @key{TAB}
1458 Invoke Bib@TeX{} on the current file (@code{tex-bibtex-file}).
1459 @item C-c C-f
1460 Invoke @TeX{} on the current file (@code{tex-file}).
1461 @item C-c C-l
1462 Recenter the window showing output from the inferior @TeX{} so that
1463 the last line can be seen (@code{tex-recenter-output-buffer}).
1464 @item C-c C-k
1465 Kill the @TeX{} subprocess (@code{tex-kill-job}).
1466 @item C-c C-p
1467 Print the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c
1468 C-f} command (@code{tex-print}).
1469 @item C-c C-v
1470 Preview the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c
1471 C-f} command (@code{tex-view}).
1472 @item C-c C-q
1473 Show the printer queue (@code{tex-show-print-queue}).
1474 @end table
1476 @findex tex-buffer
1477 @kindex C-c C-b @r{(@TeX{} mode)}
1478 @findex tex-print
1479 @kindex C-c C-p @r{(@TeX{} mode)}
1480 @findex tex-view
1481 @kindex C-c C-v @r{(@TeX{} mode)}
1482 @findex tex-show-print-queue
1483 @kindex C-c C-q @r{(@TeX{} mode)}
1484   You can pass the current buffer through an inferior @TeX{} by means of
1485 @kbd{C-c C-b} (@code{tex-buffer}).  The formatted output appears in a
1486 temporary file; to print it, type @kbd{C-c C-p} (@code{tex-print}).
1487 Afterward, you can use @kbd{C-c C-q} (@code{tex-show-print-queue}) to
1488 view the progress of your output towards being printed.  If your terminal
1489 has the ability to display @TeX{} output files, you can preview the
1490 output on the terminal with @kbd{C-c C-v} (@code{tex-view}).
1492 @cindex @env{TEXINPUTS} environment variable
1493 @vindex tex-directory
1494   You can specify the directory to use for running @TeX{} by setting the
1495 variable @code{tex-directory}.  @code{"."} is the default value.  If
1496 your environment variable @env{TEXINPUTS} contains relative directory
1497 names, or if your files contains @samp{\input} commands with relative
1498 file names, then @code{tex-directory} @emph{must} be @code{"."} or you
1499 will get the wrong results.  Otherwise, it is safe to specify some other
1500 directory, such as @code{"/tmp"}.
1502 @vindex tex-run-command
1503 @vindex latex-run-command
1504 @vindex slitex-run-command
1505 @vindex tex-dvi-print-command
1506 @vindex tex-dvi-view-command
1507 @vindex tex-show-queue-command
1508   If you want to specify which shell commands are used in the inferior @TeX{},
1509 you can do so by setting the values of the variables @code{tex-run-command},
1510 @code{latex-run-command}, @code{slitex-run-command},
1511 @code{tex-dvi-print-command}, @code{tex-dvi-view-command}, and
1512 @code{tex-show-queue-command}.  You @emph{must} set the value of
1513 @code{tex-dvi-view-command} for your particular terminal; this variable
1514 has no default value.  The other variables have default values that may
1515 (or may not) be appropriate for your system.
1517   Normally, the file name given to these commands comes at the end of
1518 the command string; for example, @samp{latex @var{filename}}.  In some
1519 cases, however, the file name needs to be embedded in the command; an
1520 example is when you need to provide the file name as an argument to one
1521 command whose output is piped to another.  You can specify where to put
1522 the file name with @samp{*} in the command string.  For example,
1524 @example
1525 (setq tex-dvi-print-command "dvips -f * | lpr")
1526 @end example
1528 @findex tex-kill-job
1529 @kindex C-c C-k @r{(@TeX{} mode)}
1530 @findex tex-recenter-output-buffer
1531 @kindex C-c C-l @r{(@TeX{} mode)}
1532   The terminal output from @TeX{}, including any error messages, appears
1533 in a buffer called @samp{*tex-shell*}.  If @TeX{} gets an error, you can
1534 switch to this buffer and feed it input (this works as in Shell mode;
1535 @pxref{Interactive Shell}).  Without switching to this buffer you can
1536 scroll it so that its last line is visible by typing @kbd{C-c
1537 C-l}.
1539   Type @kbd{C-c C-k} (@code{tex-kill-job}) to kill the @TeX{} process if
1540 you see that its output is no longer useful.  Using @kbd{C-c C-b} or
1541 @kbd{C-c C-r} also kills any @TeX{} process still running.@refill
1543 @findex tex-region
1544 @kindex C-c C-r @r{(@TeX{} mode)}
1545   You can also pass an arbitrary region through an inferior @TeX{} by typing
1546 @kbd{C-c C-r} (@code{tex-region}).  This is tricky, however, because most files
1547 of @TeX{} input contain commands at the beginning to set parameters and
1548 define macros, without which no later part of the file will format
1549 correctly.  To solve this problem, @kbd{C-c C-r} allows you to designate a
1550 part of the file as containing essential commands; it is included before
1551 the specified region as part of the input to @TeX{}.  The designated part
1552 of the file is called the @dfn{header}.
1554 @cindex header (@TeX{} mode)
1555   To indicate the bounds of the header in Plain @TeX{} mode, you insert two
1556 special strings in the file.  Insert @samp{%**start of header} before the
1557 header, and @samp{%**end of header} after it.  Each string must appear
1558 entirely on one line, but there may be other text on the line before or
1559 after.  The lines containing the two strings are included in the header.
1560 If @samp{%**start of header} does not appear within the first 100 lines of
1561 the buffer, @kbd{C-c C-r} assumes that there is no header.
1563   In La@TeX{} mode, the header begins with @samp{\documentclass} or
1564 @samp{\documentstyle} and ends with @samp{\begin@{document@}}.  These
1565 are commands that La@TeX{} requires you to use in any case, so nothing
1566 special needs to be done to identify the header.
1568 @findex tex-file
1569 @kindex C-c C-f @r{(@TeX{} mode)}
1570   The commands (@code{tex-buffer}) and (@code{tex-region}) do all of their
1571 work in a temporary directory, and do not have available any of the auxiliary
1572 files needed by @TeX{} for cross-references; these commands are generally
1573 not suitable for running the final copy in which all of the cross-references
1574 need to be correct.
1576   When you want the auxiliary files for cross references, use @kbd{C-c
1577 C-f} (@code{tex-file}) which runs @TeX{} on the current buffer's file,
1578 in that file's directory.  Before running @TeX{}, it offers to save any
1579 modified buffers.  Generally, you need to use (@code{tex-file}) twice to
1580 get the cross-references right.
1582 @vindex tex-start-options-string
1583   The value of the variable @code{tex-start-options-string} specifies
1584 options for the @TeX{} run.  The default value causes @TeX{} to run in
1585 nonstopmode.  To run @TeX{} interactively, set the variable to @code{""}.
1587 @vindex tex-main-file
1588   Large @TeX{} documents are often split into several files---one main
1589 file, plus subfiles.  Running @TeX{} on a subfile typically does not
1590 work; you have to run it on the main file.  In order to make
1591 @code{tex-file} useful when you are editing a subfile, you can set the
1592 variable @code{tex-main-file} to the name of the main file.  Then
1593 @code{tex-file} runs @TeX{} on that file.
1595   The most convenient way to use @code{tex-main-file} is to specify it
1596 in a local variable list in each of the subfiles.  @xref{File
1597 Variables}.
1599 @findex tex-bibtex-file
1600 @kindex C-c TAB @r{(@TeX{} mode)}
1601 @vindex tex-bibtex-command
1602   For La@TeX{} files, you can use Bib@TeX{} to process the auxiliary
1603 file for the current buffer's file.  Bib@TeX{} looks up bibliographic
1604 citations in a data base and prepares the cited references for the
1605 bibliography section.  The command @kbd{C-c TAB}
1606 (@code{tex-bibtex-file}) runs the shell command
1607 (@code{tex-bibtex-command}) to produce a @samp{.bbl} file for the
1608 current buffer's file.  Generally, you need to do @kbd{C-c C-f}
1609 (@code{tex-file}) once to generate the @samp{.aux} file, then do
1610 @kbd{C-c TAB} (@code{tex-bibtex-file}), and then repeat @kbd{C-c C-f}
1611 (@code{tex-file}) twice more to get the cross-references correct.
1613 @node Nroff Mode
1614 @section Nroff Mode
1616 @cindex nroff
1617 @findex nroff-mode
1618   Nroff mode is a mode like Text mode but modified to handle nroff commands
1619 present in the text.  Invoke @kbd{M-x nroff-mode} to enter this mode.  It
1620 differs from Text mode in only a few ways.  All nroff command lines are
1621 considered paragraph separators, so that filling will never garble the
1622 nroff commands.  Pages are separated by @samp{.bp} commands.  Comments
1623 start with backslash-doublequote.  Also, three special commands are
1624 provided that are not in Text mode:
1626 @findex forward-text-line
1627 @findex backward-text-line
1628 @findex count-text-lines
1629 @kindex M-n @r{(Nroff mode)}
1630 @kindex M-p @r{(Nroff mode)}
1631 @kindex M-? @r{(Nroff mode)}
1632 @table @kbd
1633 @item M-n
1634 Move to the beginning of the next line that isn't an nroff command
1635 (@code{forward-text-line}).  An argument is a repeat count.
1636 @item M-p
1637 Like @kbd{M-n} but move up (@code{backward-text-line}).
1638 @item M-?
1639 Prints in the echo area the number of text lines (lines that are not
1640 nroff commands) in the region (@code{count-text-lines}).
1641 @end table
1643 @findex electric-nroff-mode
1644   The other feature of Nroff mode is that you can turn on Electric Nroff
1645 mode.  This is a minor mode that you can turn on or off with @kbd{M-x
1646 electric-nroff-mode} (@pxref{Minor Modes}).  When the mode is on, each
1647 time you use @key{RET} to end a line that contains an nroff command that
1648 opens a kind of grouping, the matching nroff command to close that
1649 grouping is automatically inserted on the following line.  For example,
1650 if you are at the beginning of a line and type @kbd{.@: ( b @key{RET}},
1651 this inserts the matching command @samp{.)b} on a new line following
1652 point.
1654   If you use Outline minor mode with Nroff mode (@pxref{Outline Mode}),
1655 heading lines are lines of the form @samp{.H} followed by a number (the
1656 header level).
1658 @vindex nroff-mode-hook
1659   Entering Nroff mode runs the hook @code{text-mode-hook}, followed by
1660 the hook @code{nroff-mode-hook} (@pxref{Hooks}).
1662 @node Formatted Text
1663 @section Editing Formatted Text
1665 @cindex Enriched mode
1666 @cindex mode, Enriched
1667 @cindex formatted text
1668 @cindex WYSIWYG
1669 @cindex word processing
1670   @dfn{Enriched mode} is a minor mode for editing files that contain
1671 formatted text in WYSIWYG fashion, as in a word processor.  Currently,
1672 formatted text in Enriched mode can specify fonts, colors, underlining,
1673 margins, and types of filling and justification.  In the future, we plan
1674 to implement other formatting features as well.
1676   Enriched mode is a minor mode (@pxref{Minor Modes}).  Typically it is
1677 used in conjunction with Text mode (@pxref{Text Mode}).  However, you
1678 can also use it with other major modes such as Outline mode and
1679 Paragraph-Indent Text mode.
1681 @cindex text/enriched MIME format
1682   Potentially, Emacs can store formatted text files in various file
1683 formats.  Currently, only one format is implemented: @dfn{text/enriched}
1684 format, which is defined by the MIME protocol.  @xref{Format
1685 Conversion,, Format Conversion, elisp, the Emacs Lisp Reference Manual},
1686 for details of how Emacs recognizes and converts file formats.
1688   The Emacs distribution contains a formatted text file that can serve as
1689 an example.  Its name is @file{etc/enriched.doc}.  It contains samples
1690 illustrating all the features described in this section.  It also
1691 contains a list of ideas for future enhancements.
1693 @menu
1694 * Requesting Formatted Text::   Entering and exiting Enriched mode.
1695 * Hard and Soft Newlines::      There are two different kinds of newlines.
1696 * Editing Format Info::         How to edit text properties.
1697 * Faces: Format Faces.          Bold, italic, underline, etc.
1698 * Color: Format Colors.         Changing the color of text.
1699 * Indent: Format Indentation.   Changing the left and right margins.
1700 * Justification: Format Justification.
1701                                 Centering, setting text flush with the 
1702                                   left or right margin, etc.
1703 * Other: Format Properties.     The "special" text properties submenu.
1704 * Forcing Enriched Mode::       How to force use of Enriched mode.
1705 @end menu
1707 @node Requesting Formatted Text
1708 @subsection Requesting to Edit Formatted Text
1710   Whenever you visit a file that Emacs saved in the text/enriched format,
1711 Emacs automatically converts the formatting information in the file into
1712 Emacs's own internal format (text properties), and turns on Enriched
1713 mode.
1715 @findex enriched-mode
1716   To create a new file of formatted text, first visit the nonexistent
1717 file, then type @kbd{M-x enriched-mode} before you start inserting text.
1718 This command turns on Enriched mode.  Do this before you begin inserting
1719 text, to ensure that the text you insert is handled properly.
1721   More generally, the command @code{enriched-mode} turns Enriched mode
1722 on if it was off, and off if it was on.  With a prefix argument, this
1723 command turns Enriched mode on if the argument is positive, and turns
1724 the mode off otherwise.
1726   When you save a buffer while Enriched mode is enabled in it, Emacs
1727 automatically converts the text to text/enriched format while writing it
1728 into the file.  When you visit the file again, Emacs will automatically
1729 recognize the format, reconvert the text, and turn on Enriched mode
1730 again.
1732 @vindex enriched-fill-after-visiting
1733   Normally, after visiting a file in text/enriched format, Emacs refills
1734 each paragraph to fit the specified right margin.  You can turn off this
1735 refilling, to save time, by setting the variable
1736 @code{enriched-fill-after-visiting} to @code{nil} or to @code{ask}.
1738   However, when visiting a file that was saved from Enriched mode, there
1739 is no need for refilling, because Emacs saves the right margin settings
1740 along with the text.
1742 @vindex enriched-translations
1743   You can add annotations for saving additional text properties, which
1744 Emacs normally does not save, by adding to @code{enriched-translations}.
1745 Note that the text/enriched standard requires any non-standard
1746 annotations to have names starting with @samp{x-}, as in
1747 @samp{x-read-only}.  This ensures that they will not conflict with
1748 standard annotations that may be added later.
1750 @node Hard and Soft Newlines
1751 @subsection Hard and Soft Newlines
1752 @cindex hard newline
1753 @cindex soft newline
1754 @cindex newlines, hard and soft
1756   In formatted text, Emacs distinguishes between two different kinds of
1757 newlines, @dfn{hard} newlines and @dfn{soft} newlines.
1759   Hard newlines are used to separate paragraphs, or items in a list, or
1760 anywhere that there should always be a line break regardless of the
1761 margins.  The @key{RET} command (@code{newline}) and @kbd{C-o}
1762 (@code{open-line}) insert hard newlines.
1764   Soft newlines are used to make text fit between the margins.  All the
1765 fill commands, including Auto Fill, insert soft newlines---and they
1766 delete only soft newlines.
1768   Although hard and soft newlines look the same, it is important to bear
1769 the difference in mind.  Do not use @key{RET} to break lines in the
1770 middle of filled paragraphs, or else you will get hard newlines that are
1771 barriers to further filling.  Instead, let Auto Fill mode break lines,
1772 so that if the text or the margins change, Emacs can refill the lines
1773 properly.  @xref{Auto Fill}.
1775   On the other hand, in tables and lists, where the lines should always
1776 remain as you type them, you can use @key{RET} to end lines.  For these
1777 lines, you may also want to set the justification style to
1778 @code{unfilled}.  @xref{Format Justification}.
1780 @node Editing Format Info
1781 @subsection Editing Format Information
1783   There are two ways to alter the formatting information for a formatted
1784 text file: with keyboard commands, and with the mouse.
1786   The easiest way to add properties to your document is by using the Text
1787 Properties menu.  You can get to this menu in two ways: from the Edit
1788 menu in the menu bar, or with @kbd{C-mouse-2} (hold the @key{CTRL} key
1789 and press the middle mouse button).
1791   Most of the items in the Text Properties menu lead to other submenus.
1792 These are described in the sections that follow.  Some items run
1793 commands directly:
1795 @table @code
1796 @findex facemenu-remove-props
1797 @item Remove Properties
1798 Delete from the region all the text properties that the Text Properties
1799 menu works with (@code{facemenu-remove-props}).
1801 @findex facemenu-remove-all
1802 @item Remove All
1803 Delete @emph{all} text properties from the region
1804 (@code{facemenu-remove-all}).
1806 @findex list-text-properties-at
1807 @item List Properties
1808 List all the text properties of the character following point
1809 (@code{list-text-properties-at}).
1811 @item Display Faces
1812 Display a list of all the defined faces.
1814 @item Display Colors
1815 Display a list of all the defined colors.
1816 @end table
1817             
1818 @node Format Faces
1819 @subsection Faces in Formatted Text
1821   The Faces submenu lists various Emacs faces including @code{bold},
1822 @code{italic}, and @code{underline}.  Selecting one of these adds the
1823 chosen face to the region.  @xref{Faces}.  You can also specify a face
1824 with these keyboard commands:
1826 @table @kbd
1827 @kindex M-g d @r{(Enriched mode)}
1828 @findex facemenu-set-default
1829 @item M-g d
1830 Set the region, or the next inserted character, to the @code{default} face
1831 (@code{facemenu-set-default}).
1832 @kindex M-g b @r{(Enriched mode)}
1833 @findex facemenu-set-bold
1834 @item M-g b
1835 Set the region, or the next inserted character, to the @code{bold} face
1836 (@code{facemenu-set-bold}).
1837 @kindex M-g i @r{(Enriched mode)}
1838 @findex facemenu-set-italic
1839 @item M-g i
1840 Set the region, or the next inserted character, to the @code{italic} face
1841 (@code{facemenu-set-italic}).
1842 @kindex M-g l @r{(Enriched mode)}
1843 @findex facemenu-set-bold-italic
1844 @item M-g l
1845 Set the region, or the next inserted character, to the @code{bold-italic} face
1846 (@code{facemenu-set-bold-italic}).
1847 @kindex M-g u @r{(Enriched mode)}
1848 @findex facemenu-set-underline
1849 @item M-g u
1850 Set the region, or the next inserted character, to the @code{underline} face
1851 (@code{facemenu-set-underline}).
1852 @kindex M-g o @r{(Enriched mode)}
1853 @findex facemenu-set-face
1854 @item M-g o @var{face} @key{RET}
1855 Set the region, or the next inserted character, to the face @var{face}
1856 (@code{facemenu-set-face}).
1857 @end table
1859   If you use these commands with a prefix argument---or, in Transient Mark
1860 mode, if the region is not active---then these commands specify a face
1861 to use for your next self-inserting input.  @xref{Transient Mark}.  This
1862 applies to both the keyboard commands and the menu commands.
1864   Enriched mode defines two additional faces: @code{excerpt} and
1865 @code{fixed}.  These correspond to codes used in the text/enriched file
1866 format.
1868   The @code{excerpt} face is intended for quotations.  This face is the
1869 same as @code{italic} unless you customize it (@pxref{Face Customization}).
1871   The @code{fixed} face is meant to say, ``Use a fixed-width font for this
1872 part of the text.''  Emacs currently supports only fixed-width fonts;
1873 therefore, the @code{fixed} annotation is not necessary now.  However,
1874 we plan to support variable width fonts in future Emacs versions, and
1875 other systems that display text/enriched format may not use a
1876 fixed-width font as the default.  So if you specifically want a certain
1877 part of the text to use a fixed-width font, you should specify the
1878 @code{fixed} face for that part.
1880   The @code{fixed} face is normally defined to use a different font from
1881 the default.  However, different systems have different fonts installed,
1882 so you may need to customize this.
1884   If your terminal cannot display different faces, you will not be able
1885 to see them, but you can still edit documents containing faces.  You can
1886 even add faces and colors to documents.  They will be visible when the
1887 file is viewed on a terminal that can display them.
1889 @node Format Colors
1890 @subsection Colors in Formatted Text
1892   You can specify foreground and background colors for portions of the
1893 text.  There is a menu for specifying the foreground color and a menu
1894 for specifying the background color.  Each color menu lists all the
1895 colors that you have used in Enriched mode in the current Emacs session.
1897   If you specify a color with a prefix argument---or, in Transient Mark
1898 mode, if the region is not active---then it applies to your next
1899 self-inserting input.  @xref{Transient Mark}.  Otherwise, the command
1900 applies to the region.
1902   Each color menu contains one additional item: @samp{Other}.  You can use
1903 this item to specify a color that is not listed in the menu; it reads
1904 the color name with the minibuffer.  To display list of available colors
1905 and their names, use the @samp{Display Colors} menu item in the Text
1906 Properties menu (@pxref{Editing Format Info}).
1908   Any color that you specify in this way, or that is mentioned in a
1909 formatted text file that you read in, is added to both color menus for
1910 the duration of the Emacs session.
1912 @findex facemenu-set-foreground
1913 @findex facemenu-set-background
1914   There are no key bindings for specifying colors, but you can do so
1915 with the extended commands @kbd{M-x facemenu-set-foreground} and
1916 @kbd{M-x facemenu-set-background}.  Both of these commands read the name
1917 of the color with the minibuffer.
1919 @node Format Indentation
1920 @subsection Indentation in Formatted Text
1922   When editing formatted text, you can specify different amounts of
1923 indentation for the right or left margin of an entire paragraph or a
1924 part of a paragraph.  The margins you specify automatically affect the
1925 Emacs fill commands (@pxref{Filling}) and line-breaking commands.
1927   The Indentation submenu provides a convenient interface for specifying
1928 these properties.  The submenu contains four items:
1930 @table @code
1931 @kindex C-x TAB @r{(Enriched mode)}
1932 @findex increase-left-margin
1933 @item Indent More
1934 Indent the region by 4 columns (@code{increase-left-margin}).  In
1935 Enriched mode, this command is also available on @kbd{C-x @key{TAB}}; if
1936 you supply a numeric argument, that says how many columns to add to the
1937 margin (a negative argument reduces the number of columns).
1939 @item Indent Less
1940 Remove 4 columns of indentation from the region.
1942 @item Indent Right More
1943 Make the text narrower by indenting 4 columns at the right margin.
1945 @item Indent Right Less
1946 Remove 4 columns of indentation from the right margin.
1947 @end table
1949   You can use these commands repeatedly to increase or decrease the
1950 indentation.
1952   The most common way to use these commands is to change the indentation
1953 of an entire paragraph.  However, that is not the only use.  You can
1954 change the margins at any point; the new values take effect at the end
1955 of the line (for right margins) or the beginning of the next line (for
1956 left margins).
1958   This makes it possible to format paragraphs with @dfn{hanging indents},
1959 which means that the first line is indented less than subsequent lines.
1960 To set up a hanging indent, increase the indentation of the region
1961 starting after the first word of the paragraph and running until the end
1962 of the paragraph.
1964   Indenting the first line of a paragraph is easier.  Set the margin for
1965 the whole paragraph where you want it to be for the body of the
1966 paragraph, then indent the first line by inserting extra spaces or tabs.
1968   Sometimes, as a result of editing, the filling of a paragraph becomes
1969 messed up---parts of the paragraph may extend past the left or right
1970 margins.  When this happens, use @kbd{M-q} (@code{fill-paragraph}) to
1971 refill the paragraph.
1973 @vindex standard-indent
1974   The variable @code{standard-indent} specifies how many columns these
1975 commands should add to or subtract from the indentation.  The default
1976 value is 4.  The overall default right margin for Enriched mode is
1977 controlled by the variable @code{fill-column}, as usual.
1979   The fill prefix, if any, works in addition to the specified paragraph
1980 indentation: @kbd{C-x .} does not include the specified indentation's
1981 whitespace in the new value for the fill prefix, and the fill commands
1982 look for the fill prefix after the indentation on each line.  @xref{Fill
1983 Prefix}.
1985 @node Format Justification
1986 @subsection Justification in Formatted Text
1987             
1988   When editing formatted text, you can specify various styles of
1989 justification for a paragraph.  The style you specify automatically
1990 affects the Emacs fill commands.
1992   The Justification submenu provides a convenient interface for specifying
1993 the style.  The submenu contains five items:
1995 @table @code
1996 @item Flush Left
1997 This is the most common style of justification (at least for English).
1998 Lines are aligned at the left margin but left uneven at the right.
2000 @item Flush Right
2001 This aligns each line with the right margin.  Spaces and tabs are added
2002 on the left, if necessary, to make lines line up on the right.
2004 @item Full
2005 This justifies the text, aligning both edges of each line.  Justified
2006 text looks very nice in a printed book, where the spaces can all be
2007 adjusted equally, but it does not look as nice with a fixed-width font
2008 on the screen.  Perhaps a future version of Emacs will be able to adjust
2009 the width of spaces in a line to achieve elegant justification.
2011 @item Center
2012 This centers every line between the current margins.
2014 @item None
2015 This turns off filling entirely.  Each line will remain as you wrote it;
2016 the fill and auto-fill functions will have no effect on text which has
2017 this setting.  You can, however, still indent the left margin.  In
2018 unfilled regions, all newlines are treated as hard newlines (@pxref{Hard
2019 and Soft Newlines}) .
2020 @end table
2022   In Enriched mode, you can also specify justification from the keyboard
2023 using the @kbd{M-j} prefix character:
2025 @table @kbd
2026 @kindex M-j l @r{(Enriched mode)}
2027 @findex set-justification-left
2028 @item M-j l
2029 Make the region left-filled (@code{set-justification-left}).
2030 @kindex M-j r @r{(Enriched mode)}
2031 @findex set-justification-right
2032 @item M-j r
2033 Make the region right-filled (@code{set-justification-right}).
2034 @kindex M-j f @r{(Enriched mode)}
2035 @findex set-justification-full
2036 @item M-j f
2037 Make the region fully-justified (@code{set-justification-full}).
2038 @kindex M-j c @r{(Enriched mode)}
2039 @kindex M-S @r{(Enriched mode)}
2040 @findex set-justification-center
2041 @item M-j c
2042 @itemx M-S
2043 Make the region centered (@code{set-justification-center}).
2044 @kindex M-j u @r{(Enriched mode)}
2045 @findex set-justification-none
2046 @item M-j u
2047 Make the region unfilled (@code{set-justification-none}).
2048 @end table
2050   Justification styles apply to entire paragraphs.  All the
2051 justification-changing commands operate on the paragraph containing
2052 point, or, if the region is active, on all paragraphs which overlap the
2053 region.
2055 @vindex default-justification
2056   The default justification style is specified by the variable
2057 @code{default-justification}.  Its value should be one of the symbols
2058 @code{left}, @code{right}, @code{full}, @code{center}, or @code{none}.
2059          
2060 @node Format Properties
2061 @subsection Setting Other Text Properties
2063   The Other Properties menu lets you add or remove three other useful text
2064 properties: @code{read-only}, @code{invisible} and @code{intangible}.
2065 The @code{intangible} property disallows moving point within the text,
2066 the @code{invisible} text property hides text from display, and the
2067 @code{read-only} property disallows alteration of the text.
2069   Each of these special properties has a menu item to add it to the
2070 region.  The last menu item, @samp{Remove Special}, removes all of these
2071 special properties from the text in the region.
2073   Currently, the @code{invisible} and @code{intangible} properties are
2074 @emph{not} saved in the text/enriched format.  The @code{read-only}
2075 property is saved, but it is not a standard part of the text/enriched
2076 format, so other editors may not respect it.
2078 @node Forcing Enriched Mode
2079 @subsection Forcing Enriched Mode
2081   Normally, Emacs knows when you are editing formatted text because it
2082 recognizes the special annotations used in the file that you visited.
2083 However, there are situations in which you must take special actions
2084 to convert file contents or turn on Enriched mode:
2086 @itemize @bullet
2087 @item
2088 When you visit a file that was created with some other editor, Emacs may
2089 not recognize the file as being in the text/enriched format.  In this
2090 case, when you visit the file you will see the formatting commands
2091 rather than the formatted text.  Type @kbd{M-x format-decode-buffer} to
2092 translate it.
2094 @item
2095 When you @emph{insert} a file into a buffer, rather than visiting it.
2096 Emacs does the necessary conversions on the text which you insert, but
2097 it does not enable Enriched mode.  If you wish to do that, type @kbd{M-x
2098 enriched-mode}.
2099 @end itemize 
2101   The command @code{format-decode-buffer} translates text in various
2102 formats into Emacs's internal format.  It asks you to specify the format
2103 to translate from; however, normally you can type just @key{RET}, which
2104 tells Emacs to guess the format.
2106 @findex format-find-file
2107   If you wish to look at text/enriched file in its raw form, as a
2108 sequence of characters rather than as formatted text, use the @kbd{M-x
2109 find-file-literally} command.  This visits a file, like
2110 @code{find-file}, but does not do format conversion.  It also inhibits
2111 character code conversion (@pxref{Coding Systems}) and automatic
2112 uncompression (@pxref{Compressed Files}).  To disable format conversion
2113 but allow character code conversion and/or automatic uncompression if
2114 appropriate, use @code{format-find-file} with suitable arguments.