*** empty log message ***
[emacs.git] / man / text.texi
bloba83e78cc211f5e4c6df32e7f3ca10434d50e8d89
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985,86,87,93,94,95,97,2000,2001, 2002, 2004
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 @cindex skeletons
54 @cindex templates
55 @cindex autotyping
56 @cindex automatic typing
57   The ``automatic typing'' features may be useful when writing text.
58 @inforef{Top,, autotype}.
60 @menu
61 * Words::               Moving over and killing words.
62 * Sentences::           Moving over and killing sentences.
63 * Paragraphs::          Moving over paragraphs.
64 * Pages::               Moving over pages.
65 * Filling::             Filling or justifying text.
66 * Case::                Changing the case of text.
67 * Text Mode::           The major modes for editing text files.
68 * Outline Mode::        Editing outlines.
69 * TeX Mode::            Editing input to the formatter TeX.
70 * HTML Mode::           Editing HTML, SGML, and XML files.
71 * Nroff Mode::          Editing input to the formatter nroff.
72 * Formatted Text::      Editing formatted text directly in WYSIWYG fashion.
73 * Text Based Tables::   Editing text-based tables in WYSIWYG fashion.
74 @end menu
76 @node Words
77 @section Words
78 @cindex words
79 @cindex Meta commands and words
81   Emacs has commands for moving over or operating on words.  By convention,
82 the keys for them are all Meta characters.
84 @table @kbd
85 @item M-f
86 Move forward over a word (@code{forward-word}).
87 @item M-b
88 Move backward over a word (@code{backward-word}).
89 @item M-d
90 Kill up to the end of a word (@code{kill-word}).
91 @item M-@key{DEL}
92 Kill back to the beginning of a word (@code{backward-kill-word}).
93 @item M-@@
94 Mark the end of the next word (@code{mark-word}).
95 @item M-t
96 Transpose two words or drag a word across other words
97 (@code{transpose-words}).
98 @end table
100   Notice how these keys form a series that parallels the character-based
101 @kbd{C-f}, @kbd{C-b}, @kbd{C-d}, @key{DEL} and @kbd{C-t}.  @kbd{M-@@} is
102 cognate to @kbd{C-@@}, which is an alias for @kbd{C-@key{SPC}}.
104 @kindex M-f
105 @kindex M-b
106 @findex forward-word
107 @findex backward-word
108   The commands @kbd{M-f} (@code{forward-word}) and @kbd{M-b}
109 (@code{backward-word}) move forward and backward over words.  These
110 Meta characters are thus analogous to the corresponding control
111 characters, @kbd{C-f} and @kbd{C-b}, which move over single characters
112 in the text.  The analogy extends to numeric arguments, which serve as
113 repeat counts.  @kbd{M-f} with a negative argument moves backward, and
114 @kbd{M-b} with a negative argument moves forward.  Forward motion
115 stops right after the last letter of the word, while backward motion
116 stops right before the first letter.@refill
118 @kindex M-d
119 @findex kill-word
120   @kbd{M-d} (@code{kill-word}) kills the word after point.  To be
121 precise, it kills everything from point to the place @kbd{M-f} would
122 move to.  Thus, if point is in the middle of a word, @kbd{M-d} kills
123 just the part after point.  If some punctuation comes between point and the
124 next word, it is killed along with the word.  (If you wish to kill only the
125 next word but not the punctuation before it, simply do @kbd{M-f} to get
126 the end, and kill the word backwards with @kbd{M-@key{DEL}}.)
127 @kbd{M-d} takes arguments just like @kbd{M-f}.
129 @findex backward-kill-word
130 @kindex M-DEL
131   @kbd{M-@key{DEL}} (@code{backward-kill-word}) kills the word before
132 point.  It kills everything from point back to where @kbd{M-b} would
133 move to.  If point is after the space in @w{@samp{FOO, BAR}}, then
134 @w{@samp{FOO, }} is killed.  (If you wish to kill just @samp{FOO}, and
135 not the comma and the space, use @kbd{M-b M-d} instead of
136 @kbd{M-@key{DEL}}.)
138 @c Don't index M-t and transpose-words here, they are indexed in
139 @c fixit.texi, in the node "Transpose".
140 @c @kindex M-t
141 @c @findex transpose-words
142   @kbd{M-t} (@code{transpose-words}) exchanges the word before or
143 containing point with the following word.  The delimiter characters between
144 the words do not move.  For example, @w{@samp{FOO, BAR}} transposes into
145 @w{@samp{BAR, FOO}} rather than @samp{@w{BAR FOO,}}.  @xref{Transpose}, for
146 more on transposition and on arguments to transposition commands.
148 @kindex M-@@
149 @findex mark-word
150   To operate on the next @var{n} words with an operation which applies
151 between point and mark, you can either set the mark at point and then move
152 over the words, or you can use the command @kbd{M-@@} (@code{mark-word})
153 which does not move point, but sets the mark where @kbd{M-f} would move
154 to.  @kbd{M-@@} accepts a numeric argument that says how many words to
155 scan for the place to put the mark.  In Transient Mark mode, this command
156 activates the mark.
158   The word commands' understanding of syntax is completely controlled by
159 the syntax table.  Any character can, for example, be declared to be a word
160 delimiter.  @xref{Syntax}.
162 @node Sentences
163 @section Sentences
164 @cindex sentences
165 @cindex manipulating sentences
167   The Emacs commands for manipulating sentences and paragraphs are mostly
168 on Meta keys, so as to be like the word-handling commands.
170 @table @kbd
171 @item M-a
172 Move back to the beginning of the sentence (@code{backward-sentence}).
173 @item M-e
174 Move forward to the end of the sentence (@code{forward-sentence}).
175 @item M-k
176 Kill forward to the end of the sentence (@code{kill-sentence}).
177 @item C-x @key{DEL}
178 Kill back to the beginning of the sentence (@code{backward-kill-sentence}).
179 @end table
181 @kindex M-a
182 @kindex M-e
183 @findex backward-sentence
184 @findex forward-sentence
185   The commands @kbd{M-a} and @kbd{M-e} (@code{backward-sentence} and
186 @code{forward-sentence}) move to the beginning and end of the current
187 sentence, respectively.  They were chosen to resemble @kbd{C-a} and
188 @kbd{C-e}, which move to the beginning and end of a line.  Unlike them,
189 @kbd{M-a} and @kbd{M-e} if repeated or given numeric arguments move over
190 successive sentences.
192   Moving backward over a sentence places point just before the first
193 character of the sentence; moving forward places point right after the
194 punctuation that ends the sentence.  Neither one moves over the
195 whitespace at the sentence boundary.
197 @kindex M-k
198 @kindex C-x DEL
199 @findex kill-sentence
200 @findex backward-kill-sentence
201   Just as @kbd{C-a} and @kbd{C-e} have a kill command, @kbd{C-k}, to go
202 with them, so @kbd{M-a} and @kbd{M-e} have a corresponding kill command
203 @kbd{M-k} (@code{kill-sentence}) which kills from point to the end of
204 the sentence.  With minus one as an argument it kills back to the
205 beginning of the sentence.  Larger arguments serve as a repeat count.
206 There is also a command, @kbd{C-x @key{DEL}}
207 (@code{backward-kill-sentence}), for killing back to the beginning of a
208 sentence.  This command is useful when you change your mind in the
209 middle of composing text.@refill
211   The sentence commands assume that you follow the American typist's
212 convention of putting two spaces at the end of a sentence; they consider
213 a sentence to end wherever there is a @samp{.}, @samp{?} or @samp{!}
214 followed by the end of a line or two spaces, with any number of
215 @samp{)}, @samp{]}, @samp{'}, or @samp{"} characters allowed in between.
216 A sentence also begins or ends wherever a paragraph begins or ends.
218 @vindex sentence-end
219   The variable @code{sentence-end} controls recognition of the end of
220 a sentence.  If non-@code{nil}, it is a regexp that matches the last
221 few characters of a sentence, together with the whitespace following
222 the sentence.  If the value is @code{nil}, the default, then Emacs
223 computes the regexp according to various criteria.  The result is
224 normally similar to the following regexp:
226 @example
227 "[.?!][]\"')]*\\($\\| $\\|\t\\|  \\)[ \t\n]*"
228 @end example
230 @noindent
231 This example is explained in the section on regexps.  @xref{Regexps}.
233   If you want to use just one space between sentences, you should
234 set @code{sentence-end} to this value:
236 @example
237 "[.?!][]\"')]*\\($\\|\t\\| \\)[ \t\n]*"
238 @end example
240 @noindent
241 You should also set the variable @code{sentence-end-double-space} to
242 @code{nil} so that the fill commands expect and leave just one space at
243 the end of a sentence.  Note that this makes it impossible to
244 distinguish between periods that end sentences and those that indicate
245 abbreviations.
247 @node Paragraphs
248 @section Paragraphs
249 @cindex paragraphs
250 @cindex manipulating paragraphs
251 @kindex M-@{
252 @kindex M-@}
253 @findex backward-paragraph
254 @findex forward-paragraph
256   The Emacs commands for manipulating paragraphs are also Meta keys.
258 @table @kbd
259 @item M-@{
260 Move back to previous paragraph beginning (@code{backward-paragraph}).
261 @item M-@}
262 Move forward to next paragraph end (@code{forward-paragraph}).
263 @item M-h
264 Put point and mark around this or next paragraph (@code{mark-paragraph}).
265 @end table
267   @kbd{M-@{} moves to the beginning of the current or previous
268 paragraph, while @kbd{M-@}} moves to the end of the current or next
269 paragraph.  Blank lines and text-formatter command lines separate
270 paragraphs and are not considered part of any paragraph.  In Indented
271 Text mode, but not in Text mode, an indented line also starts a new
272 paragraph.  (If a paragraph is preceded by a blank line, these
273 commands treat that blank line as the beginning of the paragraph.)
275   In major modes for programs, paragraphs begin and end only at blank
276 lines.  This makes the paragraph commands continue to be useful even
277 though there are no paragraphs per se.
279   When there is a fill prefix, then paragraphs are delimited by all lines
280 which don't start with the fill prefix.  @xref{Filling}.
282 @kindex M-h
283 @findex mark-paragraph
284   When you wish to operate on a paragraph, you can use the command
285 @kbd{M-h} (@code{mark-paragraph}) to set the region around it.  Thus,
286 for example, @kbd{M-h C-w} kills the paragraph around or after point.
287 The @kbd{M-h} command puts point at the beginning and mark at the end of
288 the paragraph point was in.  In Transient Mark mode, it activates the
289 mark.  If point is between paragraphs (in a run of blank lines, or at a
290 boundary), the paragraph following point is surrounded by point and
291 mark.  If there are blank lines preceding the first line of the
292 paragraph, one of these blank lines is included in the region.
294 @vindex paragraph-start
295 @vindex paragraph-separate
296   The precise definition of a paragraph boundary is controlled by the
297 variables @code{paragraph-separate} and @code{paragraph-start}.  The
298 value of @code{paragraph-start} is a regexp that should match any line
299 that either starts or separates paragraphs.  The value of
300 @code{paragraph-separate} is another regexp that should match only lines
301 that separate paragraphs without being part of any paragraph (for
302 example, blank lines).  Lines that start a new paragraph and are
303 contained in it must match only @code{paragraph-start}, not
304 @code{paragraph-separate}.  Each regular expression must match at the
305 left margin.  For example, in Fundamental mode, @code{paragraph-start}
306 is @w{@code{"\f\\|[ \t]*$"}}, and @code{paragraph-separate} is
307 @w{@code{"[ \t\f]*$"}}.
309   Normally it is desirable for page boundaries to separate paragraphs.
310 The default values of these variables recognize the usual separator for
311 pages.
313 @node Pages
314 @section Pages
316 @cindex pages
317 @cindex formfeed
318   Files are often thought of as divided into @dfn{pages} by the
319 @dfn{formfeed} character (@acronym{ASCII} control-L, octal code 014).
320 When you print hardcopy for a file, this character forces a page break;
321 thus, each page of the file goes on a separate page on paper.  Most Emacs
322 commands treat the page-separator character just like any other
323 character: you can insert it with @kbd{C-q C-l}, and delete it with
324 @key{DEL}.  Thus, you are free to paginate your file or not.  However,
325 since pages are often meaningful divisions of the file, Emacs provides
326 commands to move over them and operate on them.
328 @table @kbd
329 @item C-x [
330 Move point to previous page boundary (@code{backward-page}).
331 @item C-x ]
332 Move point to next page boundary (@code{forward-page}).
333 @item C-x C-p
334 Put point and mark around this page (or another page) (@code{mark-page}).
335 @item C-x l
336 Count the lines in this page (@code{count-lines-page}).
337 @end table
339 @kindex C-x [
340 @kindex C-x ]
341 @findex forward-page
342 @findex backward-page
343   The @kbd{C-x [} (@code{backward-page}) command moves point to immediately
344 after the previous page delimiter.  If point is already right after a page
345 delimiter, it skips that one and stops at the previous one.  A numeric
346 argument serves as a repeat count.  The @kbd{C-x ]} (@code{forward-page})
347 command moves forward past the next page delimiter.
349 @kindex C-x C-p
350 @findex mark-page
351   The @kbd{C-x C-p} command (@code{mark-page}) puts point at the
352 beginning of the current page and the mark at the end.  The page
353 delimiter at the end is included (the mark follows it).  The page
354 delimiter at the front is excluded (point follows it).  In Transient
355 Mark mode, this command activates the mark.
357   @kbd{C-x C-p C-w} is a handy way to kill a page to move it
358 elsewhere.  If you move to another page delimiter with @kbd{C-x [} and
359 @kbd{C-x ]}, then yank the killed page, all the pages will be properly
360 delimited once again.  The reason @kbd{C-x C-p} includes only the
361 following page delimiter in the region is to ensure that.
363   A numeric argument to @kbd{C-x C-p} is used to specify which page to go
364 to, relative to the current one.  Zero means the current page.  One means
365 the next page, and @minus{}1 means the previous one.
367 @kindex C-x l
368 @findex count-lines-page
369   The @kbd{C-x l} command (@code{count-lines-page}) is good for deciding
370 where to break a page in two.  It displays in the echo area the total number
371 of lines in the current page, and then divides it up into those preceding
372 the current line and those following, as in
374 @example
375 Page has 96 (72+25) lines
376 @end example
378 @noindent
379   Notice that the sum is off by one; this is correct if point is not at the
380 beginning of a line.
382 @vindex page-delimiter
383   The variable @code{page-delimiter} controls where pages begin.  Its
384 value is a regexp that matches the beginning of a line that separates
385 pages.  The normal value of this variable is @code{"^\f"}, which
386 matches a formfeed character at the beginning of a line.
388 @node Filling
389 @section Filling Text
390 @cindex filling text
392   @dfn{Filling} text means breaking it up into lines that fit a
393 specified width.  Emacs does filling in two ways.  In Auto Fill mode,
394 inserting text with self-inserting characters also automatically fills
395 it.  There are also explicit fill commands that you can use when editing
396 text leaves it unfilled.  When you edit formatted text, you can specify
397 a style of filling for each portion of the text (@pxref{Formatted
398 Text}).
400 @menu
401 * Auto Fill::           Auto Fill mode breaks long lines automatically.
402 * Refill::              Keeping paragraphs filled.
403 * Fill Commands::       Commands to refill paragraphs and center lines.
404 * Fill Prefix::         Filling paragraphs that are indented
405                           or in a comment, etc.
406 * Adaptive Fill::       How Emacs can determine the fill prefix automatically.
407 @end menu
409 @node Auto Fill
410 @subsection Auto Fill Mode
411 @cindex Auto Fill mode
412 @cindex mode, Auto Fill
413 @cindex word wrap
415   @dfn{Auto Fill} mode is a minor mode in which lines are broken
416 automatically when they become too wide.  Breaking happens only when
417 you type a @key{SPC} or @key{RET}.
419 @table @kbd
420 @item M-x auto-fill-mode
421 Enable or disable Auto Fill mode.
422 @item @key{SPC}
423 @itemx @key{RET}
424 In Auto Fill mode, break lines when appropriate.
425 @end table
427 @findex auto-fill-mode
428   @kbd{M-x auto-fill-mode} turns Auto Fill mode on if it was off, or off
429 if it was on.  With a positive numeric argument it always turns Auto
430 Fill mode on, and with a negative argument always turns it off.  You can
431 see when Auto Fill mode is in effect by the presence of the word
432 @samp{Fill} in the mode line, inside the parentheses.  Auto Fill mode is
433 a minor mode which is enabled or disabled for each buffer individually.
434 @xref{Minor Modes}.
436   In Auto Fill mode, lines are broken automatically at spaces when they
437 get longer than the desired width.  Line breaking and rearrangement
438 takes place only when you type @key{SPC} or @key{RET}.  If you wish to
439 insert a space or newline without permitting line-breaking, type
440 @kbd{C-q @key{SPC}} or @kbd{C-q C-j} (recall that a newline is really a
441 control-J).  Also, @kbd{C-o} inserts a newline without line breaking.
443   Auto Fill mode works well with programming-language modes, because it
444 indents new lines with @key{TAB}.  If a line ending in a comment gets
445 too long, the text of the comment is split into two comment lines.
446 Optionally, new comment delimiters are inserted at the end of the first
447 line and the beginning of the second so that each line is a separate
448 comment; the variable @code{comment-multi-line} controls the choice
449 (@pxref{Comments}).
451   Adaptive filling (@pxref{Adaptive Fill}) works for Auto Filling as
452 well as for explicit fill commands.  It takes a fill prefix
453 automatically from the second or first line of a paragraph.
455   Auto Fill mode does not refill entire paragraphs; it can break lines but
456 cannot merge lines.  So editing in the middle of a paragraph can result in
457 a paragraph that is not correctly filled.  The easiest way to make the
458 paragraph properly filled again is usually with the explicit fill commands.
459 @ifinfo
460 @xref{Fill Commands}.
461 @end ifinfo
463   Many users like Auto Fill mode and want to use it in all text files.
464 The section on init files says how to arrange this permanently for yourself.
465 @xref{Init File}.
467 @node Refill
468 @subsection Refill Mode
469 @cindex refilling text, word processor style
470 @cindex modes, Refill
471 @cindex Refill minor mode
473   Refill minor mode provides support for keeping paragraphs filled as
474 you type or modify them in other ways.  It provides an effect similar
475 to typical word processor behavior.  This works by running a
476 paragraph-filling command at suitable times.
478   When you are typing text, only characters which normally trigger
479 auto filling, like the space character, will trigger refilling.  This
480 is to avoid making it too slow.  Apart from self-inserting characters,
481 other commands which modify the text cause refilling.
483   The current implementation is preliminary and probably not robust.
484 We expect to improve on it.
486   To toggle the use of Refill mode in the current buffer, type
487 @kbd{M-x refill-mode}.
489 @node Fill Commands
490 @subsection Explicit Fill Commands
492 @table @kbd
493 @item M-q
494 Fill current paragraph (@code{fill-paragraph}).
495 @item C-x f
496 Set the fill column (@code{set-fill-column}).
497 @item M-x fill-region
498 Fill each paragraph in the region (@code{fill-region}).
499 @item M-x fill-region-as-paragraph
500 Fill the region, considering it as one paragraph.
501 @item M-s
502 Center a line.
503 @end table
505 @kindex M-q
506 @findex fill-paragraph
507   To refill a paragraph, use the command @kbd{M-q}
508 (@code{fill-paragraph}).  This operates on the paragraph that point is
509 inside, or the one after point if point is between paragraphs.
510 Refilling works by removing all the line-breaks, then inserting new ones
511 where necessary.
513 @findex fill-region
514   To refill many paragraphs, use @kbd{M-x fill-region}, which
515 divides the region into paragraphs and fills each of them.
517 @findex fill-region-as-paragraph
518   @kbd{M-q} and @code{fill-region} use the same criteria as @kbd{M-h}
519 for finding paragraph boundaries (@pxref{Paragraphs}).  For more
520 control, you can use @kbd{M-x fill-region-as-paragraph}, which refills
521 everything between point and mark.  This command deletes any blank lines
522 within the region, so separate blocks of text end up combined into one
523 block.@refill
525 @cindex justification
526   A numeric argument to @kbd{M-q} causes it to @dfn{justify} the text as
527 well as filling it.  This means that extra spaces are inserted to make
528 the right margin line up exactly at the fill column.  To remove the
529 extra spaces, use @kbd{M-q} with no argument.  (Likewise for
530 @code{fill-region}.)  Another way to control justification, and choose
531 other styles of filling, is with the @code{justification} text property;
532 see @ref{Format Justification}.
534 @kindex M-s @r{(Text mode)}
535 @cindex centering
536 @findex center-line
537   The command @kbd{M-s} (@code{center-line}) centers the current line
538 within the current fill column.  With an argument @var{n}, it centers
539 @var{n} lines individually and moves past them.  This binding is
540 made by Text mode and is available only in that and related modes
541 (@pxref{Text Mode}).
543 @vindex fill-column
544 @kindex C-x f
545 @findex set-fill-column
546   The maximum line width for filling is in the variable
547 @code{fill-column}.  Altering the value of @code{fill-column} makes it
548 local to the current buffer; until that time, the default value is in
549 effect.  The default is initially 70.  @xref{Locals}.  The easiest way
550 to set @code{fill-column} is to use the command @kbd{C-x f}
551 (@code{set-fill-column}).  With a numeric argument, it uses that as the
552 new fill column.  With just @kbd{C-u} as argument, it sets
553 @code{fill-column} to the current horizontal position of point.
555   Emacs commands normally consider a period followed by two spaces or by
556 a newline as the end of a sentence; a period followed by just one space
557 indicates an abbreviation and not the end of a sentence.  To preserve
558 the distinction between these two ways of using a period, the fill
559 commands do not break a line after a period followed by just one space.
561 @vindex sentence-end-double-space
562   If the variable @code{sentence-end-double-space} is @code{nil}, the
563 fill commands expect and leave just one space at the end of a sentence.
564 Ordinarily this variable is @code{t}, so the fill commands insist on
565 two spaces for the end of a sentence, as explained above.  @xref{Sentences}.
567 @vindex colon-double-space
568   If the variable @code{colon-double-space} is non-@code{nil}, the
569 fill commands put two spaces after a colon.
571 @vindex sentence-end-without-period
572   Some languages do not use period to indicate end of sentence.  For
573 example, a sentence in Thai text ends with double space but without a
574 period.  Set the variable @code{sentence-end-without-period} to
575 @code{t} to tell the sentence commands that a period is not necessary.
577 @vindex fill-nobreak-predicate
578   The variable @code{fill-nobreak-predicate} specifies additional
579 conditions for where line-breaking is allowed.  Its value is either
580 @code{nil} or a Lisp function; the function is called with no
581 arguments, and if it returns a non-@code{nil} value, then point is not
582 a good place to break the line.  Two standard functions you can use are
583 @code{fill-single-word-nobreak-p} (don't break after the first word of
584 a sentence or before the last) and @code{fill-french-nobreak-p} (don't
585 break after @samp{(} or before @samp{)}, @samp{:} or @samp{?}).
587 @node Fill Prefix
588 @subsection The Fill Prefix
590 @cindex fill prefix
591   To fill a paragraph in which each line starts with a special marker
592 (which might be a few spaces, giving an indented paragraph), you can use
593 the @dfn{fill prefix} feature.  The fill prefix is a string that Emacs
594 expects every line to start with, and which is not included in filling.
595 You can specify a fill prefix explicitly; Emacs can also deduce the
596 fill prefix automatically (@pxref{Adaptive Fill}).
598 @table @kbd
599 @item C-x .
600 Set the fill prefix (@code{set-fill-prefix}).
601 @item M-q
602 Fill a paragraph using current fill prefix (@code{fill-paragraph}).
603 @item M-x fill-individual-paragraphs
604 Fill the region, considering each change of indentation as starting a
605 new paragraph.
606 @item M-x fill-nonuniform-paragraphs
607 Fill the region, considering only paragraph-separator lines as starting
608 a new paragraph.
609 @end table
611 @kindex C-x .
612 @findex set-fill-prefix
613   To specify a fill prefix for the current buffer, move to a line that
614 starts with the desired prefix, put point at the end of the prefix,
615 and give the command @w{@kbd{C-x .}}@: (@code{set-fill-prefix}).
616 That's a period after the @kbd{C-x}.  To turn off the fill prefix,
617 specify an empty prefix: type @w{@kbd{C-x .}}@: with point at the
618 beginning of a line.@refill
620   When a fill prefix is in effect, the fill commands remove the fill
621 prefix from each line before filling and insert it on each line after
622 filling.  (The beginning of the first line is left unchanged, since
623 often that is intentionally different.)  Auto Fill mode also inserts
624 the fill prefix automatically when it makes a new line.  The @kbd{C-o}
625 command inserts the fill prefix on new lines it creates, when you use
626 it at the beginning of a line (@pxref{Blank Lines}).  Conversely, the
627 command @kbd{M-^} deletes the prefix (if it occurs) after the newline
628 that it deletes (@pxref{Indentation}).
630   For example, if @code{fill-column} is 40 and you set the fill prefix
631 to @samp{;; }, then @kbd{M-q} in the following text
633 @example
634 ;; This is an
635 ;; example of a paragraph
636 ;; inside a Lisp-style comment.
637 @end example
639 @noindent
640 produces this:
642 @example
643 ;; This is an example of a paragraph
644 ;; inside a Lisp-style comment.
645 @end example
647   Lines that do not start with the fill prefix are considered to start
648 paragraphs, both in @kbd{M-q} and the paragraph commands; this gives
649 good results for paragraphs with hanging indentation (every line
650 indented except the first one).  Lines which are blank or indented once
651 the prefix is removed also separate or start paragraphs; this is what
652 you want if you are writing multi-paragraph comments with a comment
653 delimiter on each line.
655 @findex fill-individual-paragraphs
656   You can use @kbd{M-x fill-individual-paragraphs} to set the fill
657 prefix for each paragraph automatically.  This command divides the
658 region into paragraphs, treating every change in the amount of
659 indentation as the start of a new paragraph, and fills each of these
660 paragraphs.  Thus, all the lines in one ``paragraph'' have the same
661 amount of indentation.  That indentation serves as the fill prefix for
662 that paragraph.
664 @findex fill-nonuniform-paragraphs
665   @kbd{M-x fill-nonuniform-paragraphs} is a similar command that divides
666 the region into paragraphs in a different way.  It considers only
667 paragraph-separating lines (as defined by @code{paragraph-separate}) as
668 starting a new paragraph.  Since this means that the lines of one
669 paragraph may have different amounts of indentation, the fill prefix
670 used is the smallest amount of indentation of any of the lines of the
671 paragraph.  This gives good results with styles that indent a paragraph's
672 first line more or less that the rest of the paragraph.
674 @vindex fill-prefix
675   The fill prefix is stored in the variable @code{fill-prefix}.  Its value
676 is a string, or @code{nil} when there is no fill prefix.  This is a
677 per-buffer variable; altering the variable affects only the current buffer,
678 but there is a default value which you can change as well.  @xref{Locals}.
680   The @code{indentation} text property provides another way to control
681 the amount of indentation paragraphs receive.  @xref{Format Indentation}.
683 @node Adaptive Fill
684 @subsection Adaptive Filling
686 @cindex adaptive filling
687   The fill commands can deduce the proper fill prefix for a paragraph
688 automatically in certain cases: either whitespace or certain punctuation
689 characters at the beginning of a line are propagated to all lines of the
690 paragraph.
692   If the paragraph has two or more lines, the fill prefix is taken from
693 the paragraph's second line, but only if it appears on the first line as
694 well.
696   If a paragraph has just one line, fill commands @emph{may} take a
697 prefix from that line.  The decision is complicated because there are
698 three reasonable things to do in such a case:
700 @itemize @bullet
701 @item
702 Use the first line's prefix on all the lines of the paragraph.
704 @item
705 Indent subsequent lines with whitespace, so that they line up under the
706 text that follows the prefix on the first line, but don't actually copy
707 the prefix from the first line.
709 @item
710 Don't do anything special with the second and following lines.
711 @end itemize
713   All three of these styles of formatting are commonly used.  So the
714 fill commands try to determine what you would like, based on the prefix
715 that appears and on the major mode.  Here is how.
717 @vindex adaptive-fill-first-line-regexp
718   If the prefix found on the first line matches
719 @code{adaptive-fill-first-line-regexp}, or if it appears to be a
720 comment-starting sequence (this depends on the major mode), then the
721 prefix found is used for filling the paragraph, provided it would not
722 act as a paragraph starter on subsequent lines.
724   Otherwise, the prefix found is converted to an equivalent number of
725 spaces, and those spaces are used as the fill prefix for the rest of the
726 lines, provided they would not act as a paragraph starter on subsequent
727 lines.
729   In Text mode, and other modes where only blank lines and page
730 delimiters separate paragraphs, the prefix chosen by adaptive filling
731 never acts as a paragraph starter, so it can always be used for filling.
733 @vindex adaptive-fill-mode
734 @vindex adaptive-fill-regexp
735   The variable @code{adaptive-fill-regexp} determines what kinds of line
736 beginnings can serve as a fill prefix: any characters at the start of
737 the line that match this regular expression are used.  If you set the
738 variable @code{adaptive-fill-mode} to @code{nil}, the fill prefix is
739 never chosen automatically.
741 @vindex adaptive-fill-function
742   You can specify more complex ways of choosing a fill prefix
743 automatically by setting the variable @code{adaptive-fill-function} to a
744 function.  This function is called with point after the left margin of a
745 line, and it should return the appropriate fill prefix based on that
746 line.  If it returns @code{nil}, that means it sees no fill prefix in
747 that line.
749 @node Case
750 @section Case Conversion Commands
751 @cindex case conversion
753   Emacs has commands for converting either a single word or any arbitrary
754 range of text to upper case or to lower case.
756 @table @kbd
757 @item M-l
758 Convert following word to lower case (@code{downcase-word}).
759 @item M-u
760 Convert following word to upper case (@code{upcase-word}).
761 @item M-c
762 Capitalize the following word (@code{capitalize-word}).
763 @item C-x C-l
764 Convert region to lower case (@code{downcase-region}).
765 @item C-x C-u
766 Convert region to upper case (@code{upcase-region}).
767 @end table
769 @kindex M-l
770 @kindex M-u
771 @kindex M-c
772 @cindex words, case conversion
773 @cindex converting text to upper or lower case
774 @cindex capitalizing words
775 @findex downcase-word
776 @findex upcase-word
777 @findex capitalize-word
778   The word conversion commands are the most useful.  @kbd{M-l}
779 (@code{downcase-word}) converts the word after point to lower case, moving
780 past it.  Thus, repeating @kbd{M-l} converts successive words.
781 @kbd{M-u} (@code{upcase-word}) converts to all capitals instead, while
782 @kbd{M-c} (@code{capitalize-word}) puts the first letter of the word
783 into upper case and the rest into lower case.  All these commands convert
784 several words at once if given an argument.  They are especially convenient
785 for converting a large amount of text from all upper case to mixed case,
786 because you can move through the text using @kbd{M-l}, @kbd{M-u} or
787 @kbd{M-c} on each word as appropriate, occasionally using @kbd{M-f} instead
788 to skip a word.
790   When given a negative argument, the word case conversion commands apply
791 to the appropriate number of words before point, but do not move point.
792 This is convenient when you have just typed a word in the wrong case: you
793 can give the case conversion command and continue typing.
795   If a word case conversion command is given in the middle of a word, it
796 applies only to the part of the word which follows point.  This is just
797 like what @kbd{M-d} (@code{kill-word}) does.  With a negative argument,
798 case conversion applies only to the part of the word before point.
800 @kindex C-x C-l
801 @kindex C-x C-u
802 @findex downcase-region
803 @findex upcase-region
804   The other case conversion commands are @kbd{C-x C-u}
805 (@code{upcase-region}) and @kbd{C-x C-l} (@code{downcase-region}), which
806 convert everything between point and mark to the specified case.  Point and
807 mark do not move.
809   The region case conversion commands @code{upcase-region} and
810 @code{downcase-region} are normally disabled.  This means that they ask
811 for confirmation if you try to use them.  When you confirm, you may
812 enable the command, which means it will not ask for confirmation again.
813 @xref{Disabling}.
815 @node Text Mode
816 @section Text Mode
817 @cindex Text mode
818 @cindex mode, Text
819 @findex text-mode
821   When you edit files of text in a human language, it's more convenient
822 to use Text mode rather than Fundamental mode.  To enter Text mode, type
823 @kbd{M-x text-mode}.
825   In Text mode, only blank lines and page delimiters separate
826 paragraphs.  As a result, paragraphs can be indented, and adaptive
827 filling determines what indentation to use when filling a paragraph.
828 @xref{Adaptive Fill}.
830 @kindex TAB @r{(Text mode)}
831   Text mode defines @key{TAB} to run @code{indent-relative}
832 (@pxref{Indentation}), so that you can conveniently indent a line like
833 the previous line.
835   Text mode turns off the features concerned with comments except when
836 you explicitly invoke them.  It changes the syntax table so that
837 single-quotes are considered part of words.  However, if a word starts
838 with single-quotes, then these are treated as a prefix for purposes
839 such as capitalization.  That is, @kbd{M-c} will convert
840 @samp{'hello'} into @samp{'Hello'}, as expected.
842 @cindex Paragraph-Indent Text mode
843 @cindex mode, Paragraph-Indent Text
844 @findex paragraph-indent-text-mode
845 @findex paragraph-indent-minor-mode
846   If you indent the first lines of paragraphs, then you should use
847 Paragraph-Indent Text mode rather than Text mode.  In this mode, you do
848 not need to have blank lines between paragraphs, because the first-line
849 indentation is sufficient to start a paragraph; however paragraphs in
850 which every line is indented are not supported.  Use @kbd{M-x
851 paragraph-indent-text-mode} to enter this mode.  Use @kbd{M-x
852 paragraph-indent-minor-mode} to enter an equivalent minor mode, for
853 instance during mail composition.
855 @kindex M-TAB @r{(Text mode)}
856   Text mode, and all the modes based on it, define @kbd{M-@key{TAB}} as
857 the command @code{ispell-complete-word}, which performs completion of
858 the partial word in the buffer before point, using the spelling
859 dictionary as the space of possible words.  @xref{Spelling}.
861 @vindex text-mode-hook
862   Entering Text mode runs the hook @code{text-mode-hook}.  Other major
863 modes related to Text mode also run this hook, followed by hooks of
864 their own; this includes Paragraph-Indent Text mode, Nroff mode, @TeX{}
865 mode, Outline mode, and Mail mode.  Hook functions on
866 @code{text-mode-hook} can look at the value of @code{major-mode} to see
867 which of these modes is actually being entered.  @xref{Hooks}.
869 @ifinfo
870   Emacs provides two other modes for editing text that is to be passed
871 through a text formatter to produce fancy formatted printed output.
872 @xref{Nroff Mode}, for editing input to the formatter nroff.
873 @xref{TeX Mode}, for editing input to the formatter TeX.
875   Another mode is used for editing outlines.  It allows you to view the
876 text at various levels of detail.  You can view either the outline
877 headings alone or both headings and text; you can also hide some of the
878 headings at lower levels from view to make the high level structure more
879 visible.  @xref{Outline Mode}.
880 @end ifinfo
882 @node Outline Mode
883 @section Outline Mode
884 @cindex Outline mode
885 @cindex mode, Outline
886 @cindex invisible lines
888 @findex outline-mode
889 @findex outline-minor-mode
890 @vindex outline-minor-mode-prefix
891   Outline mode is a major mode much like Text mode but intended for
892 editing outlines.  It allows you to make parts of the text temporarily
893 invisible so that you can see the outline structure.  Type @kbd{M-x
894 outline-mode} to switch to Outline mode as the major mode of the current
895 buffer.
897   When Outline mode makes a line invisible, the line does not appear on
898 the screen.  The screen appears exactly as if the invisible line were
899 deleted, except that an ellipsis (three periods in a row) appears at the
900 end of the previous visible line (only one ellipsis no matter how many
901 invisible lines follow).
903   Editing commands that operate on lines, such as @kbd{C-n} and
904 @kbd{C-p}, treat the text of the invisible line as part of the previous
905 visible line.  Killing the ellipsis at the end of a visible line
906 really kills all the following invisible lines.
908   Outline minor mode provides the same commands as the major mode,
909 Outline mode, but you can use it in conjunction with other major modes.
910 Type @kbd{M-x outline-minor-mode} to enable the Outline minor mode in
911 the current buffer.  You can also specify this in the text of a file,
912 with a file local variable of the form @samp{mode: outline-minor}
913 (@pxref{File Variables}).
915 @kindex C-c @@ @r{(Outline minor mode)}
916   The major mode, Outline mode, provides special key bindings on the
917 @kbd{C-c} prefix.  Outline minor mode provides similar bindings with
918 @kbd{C-c @@} as the prefix; this is to reduce the conflicts with the
919 major mode's special commands.  (The variable
920 @code{outline-minor-mode-prefix} controls the prefix used.)
922 @vindex outline-mode-hook
923   Entering Outline mode runs the hook @code{text-mode-hook} followed by
924 the hook @code{outline-mode-hook} (@pxref{Hooks}).
926 @menu
927 * Format: Outline Format.          What the text of an outline looks like.
928 * Motion: Outline Motion.          Special commands for moving through
929                                      outlines.
930 * Visibility: Outline Visibility.  Commands to control what is visible.
931 * Views: Outline Views.            Outlines and multiple views.
932 * Foldout::                        Folding editing.
933 @end menu
935 @node Outline Format
936 @subsection Format of Outlines
938 @cindex heading lines (Outline mode)
939 @cindex body lines (Outline mode)
940   Outline mode assumes that the lines in the buffer are of two types:
941 @dfn{heading lines} and @dfn{body lines}.  A heading line represents a
942 topic in the outline.  Heading lines start with one or more stars; the
943 number of stars determines the depth of the heading in the outline
944 structure.  Thus, a heading line with one star is a major topic; all the
945 heading lines with two stars between it and the next one-star heading
946 are its subtopics; and so on.  Any line that is not a heading line is a
947 body line.  Body lines belong with the preceding heading line.  Here is
948 an example:
950 @example
951 * Food
952 This is the body,
953 which says something about the topic of food.
955 ** Delicious Food
956 This is the body of the second-level header.
958 ** Distasteful Food
959 This could have
960 a body too, with
961 several lines.
963 *** Dormitory Food
965 * Shelter
966 Another first-level topic with its header line.
967 @end example
969   A heading line together with all following body lines is called
970 collectively an @dfn{entry}.  A heading line together with all following
971 deeper heading lines and their body lines is called a @dfn{subtree}.
973 @vindex outline-regexp
974   You can customize the criterion for distinguishing heading lines
975 by setting the variable @code{outline-regexp}.  Any line whose
976 beginning has a match for this regexp is considered a heading line.
977 Matches that start within a line (not at the left margin) do not count.
978 The length of the matching text determines the level of the heading;
979 longer matches make a more deeply nested level.  Thus, for example,
980 if a text formatter has commands @samp{@@chapter}, @samp{@@section}
981 and @samp{@@subsection} to divide the document into chapters and
982 sections, you could make those lines count as heading lines by
983 setting @code{outline-regexp} to @samp{"@@chap\\|@@\\(sub\\)*section"}.
984 Note the trick: the two words @samp{chapter} and @samp{section} are equally
985 long, but by defining the regexp to match only @samp{chap} we ensure
986 that the length of the text matched on a chapter heading is shorter,
987 so that Outline mode will know that sections are contained in chapters.
988 This works as long as no other command starts with @samp{@@chap}.
990 @vindex outline-level
991   You can change the rule for calculating the level of a heading line
992 by setting the variable @code{outline-level}.  The value of
993 @code{outline-level} should be a function that takes no arguments and
994 returns the level of the current heading.  Some major modes such as C,
995 Nroff, and Emacs Lisp mode set this variable and @code{outline-regexp}
996 in order to work with Outline minor mode.
998 @node Outline Motion
999 @subsection Outline Motion Commands
1001   Outline mode provides special motion commands that move backward and
1002 forward to heading lines.
1004 @table @kbd
1005 @item C-c C-n
1006 Move point to the next visible heading line
1007 (@code{outline-next-visible-heading}).
1008 @item C-c C-p
1009 Move point to the previous visible heading line
1010 (@code{outline-previous-visible-heading}).
1011 @item C-c C-f
1012 Move point to the next visible heading line at the same level
1013 as the one point is on (@code{outline-forward-same-level}).
1014 @item C-c C-b
1015 Move point to the previous visible heading line at the same level
1016 (@code{outline-backward-same-level}).
1017 @item C-c C-u
1018 Move point up to a lower-level (more inclusive) visible heading line
1019 (@code{outline-up-heading}).
1020 @end table
1022 @findex outline-next-visible-heading
1023 @findex outline-previous-visible-heading
1024 @kindex C-c C-n @r{(Outline mode)}
1025 @kindex C-c C-p @r{(Outline mode)}
1026   @kbd{C-c C-n} (@code{outline-next-visible-heading}) moves down to the next
1027 heading line.  @kbd{C-c C-p} (@code{outline-previous-visible-heading}) moves
1028 similarly backward.  Both accept numeric arguments as repeat counts.  The
1029 names emphasize that invisible headings are skipped, but this is not really
1030 a special feature.  All editing commands that look for lines ignore the
1031 invisible lines automatically.@refill
1033 @findex outline-up-heading
1034 @findex outline-forward-same-level
1035 @findex outline-backward-same-level
1036 @kindex C-c C-f @r{(Outline mode)}
1037 @kindex C-c C-b @r{(Outline mode)}
1038 @kindex C-c C-u @r{(Outline mode)}
1039   More powerful motion commands understand the level structure of headings.
1040 @kbd{C-c C-f} (@code{outline-forward-same-level}) and
1041 @kbd{C-c C-b} (@code{outline-backward-same-level}) move from one
1042 heading line to another visible heading at the same depth in
1043 the outline.  @kbd{C-c C-u} (@code{outline-up-heading}) moves
1044 backward to another heading that is less deeply nested.
1046 @node Outline Visibility
1047 @subsection Outline Visibility Commands
1049   The other special commands of outline mode are used to make lines visible
1050 or invisible.  Their names all start with @code{hide} or @code{show}.
1051 Most of them fall into pairs of opposites.  They are not undoable; instead,
1052 you can undo right past them.  Making lines visible or invisible is simply
1053 not recorded by the undo mechanism.
1055 @table @kbd
1056 @item C-c C-t
1057 Make all body lines in the buffer invisible (@code{hide-body}).
1058 @item C-c C-a
1059 Make all lines in the buffer visible (@code{show-all}).
1060 @item C-c C-d
1061 Make everything under this heading invisible, not including this
1062 heading itself (@code{hide-subtree}).
1063 @item C-c C-s
1064 Make everything under this heading visible, including body,
1065 subheadings, and their bodies (@code{show-subtree}).
1066 @item C-c C-l
1067 Make the body of this heading line, and of all its subheadings,
1068 invisible (@code{hide-leaves}).
1069 @item C-c C-k
1070 Make all subheadings of this heading line, at all levels, visible
1071 (@code{show-branches}).
1072 @item C-c C-i
1073 Make immediate subheadings (one level down) of this heading line
1074 visible (@code{show-children}).
1075 @item C-c C-c
1076 Make this heading line's body invisible (@code{hide-entry}).
1077 @item C-c C-e
1078 Make this heading line's body visible (@code{show-entry}).
1079 @item C-c C-q
1080 Hide everything except the top @var{n} levels of heading lines
1081 (@code{hide-sublevels}).
1082 @item C-c C-o
1083 Hide everything except for the heading or body that point is in, plus
1084 the headings leading up from there to the top level of the outline
1085 (@code{hide-other}).
1086 @end table
1088 @findex hide-entry
1089 @findex show-entry
1090 @kindex C-c C-c @r{(Outline mode)}
1091 @kindex C-c C-e @r{(Outline mode)}
1092   Two commands that are exact opposites are @kbd{C-c C-c}
1093 (@code{hide-entry}) and @kbd{C-c C-e} (@code{show-entry}).  They are
1094 used with point on a heading line, and apply only to the body lines of
1095 that heading.  Subheadings and their bodies are not affected.
1097 @findex hide-subtree
1098 @findex show-subtree
1099 @kindex C-c C-s @r{(Outline mode)}
1100 @kindex C-c C-d @r{(Outline mode)}
1101 @cindex subtree (Outline mode)
1102   Two more powerful opposites are @kbd{C-c C-d} (@code{hide-subtree}) and
1103 @kbd{C-c C-s} (@code{show-subtree}).  Both expect to be used when point is
1104 on a heading line, and both apply to all the lines of that heading's
1105 @dfn{subtree}: its body, all its subheadings, both direct and indirect, and
1106 all of their bodies.  In other words, the subtree contains everything
1107 following this heading line, up to and not including the next heading of
1108 the same or higher rank.@refill
1110 @findex hide-leaves
1111 @findex show-branches
1112 @kindex C-c C-l @r{(Outline mode)}
1113 @kindex C-c C-k @r{(Outline mode)}
1114   Intermediate between a visible subtree and an invisible one is having
1115 all the subheadings visible but none of the body.  There are two
1116 commands for doing this, depending on whether you want to hide the
1117 bodies or make the subheadings visible.  They are @kbd{C-c C-l}
1118 (@code{hide-leaves}) and @kbd{C-c C-k} (@code{show-branches}).
1120 @kindex C-c C-i @r{(Outline mode)}
1121 @findex show-children
1122   A little weaker than @code{show-branches} is @kbd{C-c C-i}
1123 (@code{show-children}).  It makes just the direct subheadings
1124 visible---those one level down.  Deeper subheadings remain invisible, if
1125 they were invisible.@refill
1127 @findex hide-body
1128 @findex show-all
1129 @kindex C-c C-t @r{(Outline mode)}
1130 @kindex C-c C-a @r{(Outline mode)}
1131   Two commands have a blanket effect on the whole file.  @kbd{C-c C-t}
1132 (@code{hide-body}) makes all body lines invisible, so that you see just
1133 the outline structure.  @kbd{C-c C-a} (@code{show-all}) makes all lines
1134 visible.  These commands can be thought of as a pair of opposites even
1135 though @kbd{C-c C-a} applies to more than just body lines.
1137 @findex hide-sublevels
1138 @kindex C-c C-q @r{(Outline mode)}
1139   The command @kbd{C-c C-q} (@code{hide-sublevels}) hides all but the
1140 top level headings.  With a numeric argument @var{n}, it hides everything
1141 except the top @var{n} levels of heading lines.
1143 @findex hide-other
1144 @kindex C-c C-o @r{(Outline mode)}
1145   The command @kbd{C-c C-o} (@code{hide-other}) hides everything except
1146 the heading and body text that point is in, plus its parents (the headers
1147 leading up from there to top level in the outline) and the top level
1148 headings.
1150 @findex reveal-mode
1151   When incremental search finds text that is hidden by Outline mode,
1152 it makes that part of the buffer visible.  If you exit the search
1153 at that position, the text remains visible.  You can also
1154 automatically make text visible as you navigate in it by using
1155 @kbd{M-x reveal-mode}.
1157 @node Outline Views
1158 @subsection Viewing One Outline in Multiple Views
1160 @cindex multiple views of outline
1161 @cindex views of an outline
1162 @cindex outline with multiple views
1163 @cindex indirect buffers and outlines
1164   You can display two views of a single outline at the same time, in
1165 different windows.  To do this, you must create an indirect buffer using
1166 @kbd{M-x make-indirect-buffer}.  The first argument of this command is
1167 the existing outline buffer name, and its second argument is the name to
1168 use for the new indirect buffer.  @xref{Indirect Buffers}.
1170   Once the indirect buffer exists, you can display it in a window in the
1171 normal fashion, with @kbd{C-x 4 b} or other Emacs commands.  The Outline
1172 mode commands to show and hide parts of the text operate on each buffer
1173 independently; as a result, each buffer can have its own view.  If you
1174 want more than two views on the same outline, create additional indirect
1175 buffers.
1177 @node Foldout
1178 @subsection Folding Editing
1180 @cindex folding editing
1181   The Foldout package extends Outline mode and Outline minor mode with
1182 ``folding'' commands.  The idea of folding is that you zoom in on a
1183 nested portion of the outline, while hiding its relatives at higher
1184 levels.
1186   Consider an Outline mode buffer with all the text and subheadings under
1187 level-1 headings hidden.  To look at what is hidden under one of these
1188 headings, you could use @kbd{C-c C-e} (@kbd{M-x show-entry}) to expose
1189 the body, or @kbd{C-c C-i} to expose the child (level-2) headings.
1191 @kindex C-c C-z
1192 @findex foldout-zoom-subtree
1193   With Foldout, you use @kbd{C-c C-z} (@kbd{M-x foldout-zoom-subtree}).
1194 This exposes the body and child subheadings, and narrows the buffer so
1195 that only the @w{level-1} heading, the body and the level-2 headings are
1196 visible.  Now to look under one of the level-2 headings, position the
1197 cursor on it and use @kbd{C-c C-z} again.  This exposes the level-2 body
1198 and its level-3 child subheadings and narrows the buffer again.  Zooming
1199 in on successive subheadings can be done as much as you like.  A string
1200 in the mode line shows how deep you've gone.
1202   When zooming in on a heading, to see only the child subheadings specify
1203 a numeric argument: @kbd{C-u C-c C-z}.  The number of levels of children
1204 can be specified too (compare @kbd{M-x show-children}), e.g.@: @kbd{M-2
1205 C-c C-z} exposes two levels of child subheadings.  Alternatively, the
1206 body can be specified with a negative argument: @kbd{M-- C-c C-z}.  The
1207 whole subtree can be expanded, similarly to @kbd{C-c C-s} (@kbd{M-x
1208 show-subtree}), by specifying a zero argument: @kbd{M-0 C-c C-z}.
1210   While you're zoomed in, you can still use Outline mode's exposure and
1211 hiding functions without disturbing Foldout.  Also, since the buffer is
1212 narrowed, ``global'' editing actions will only affect text under the
1213 zoomed-in heading.  This is useful for restricting changes to a
1214 particular chapter or section of your document.
1216 @kindex C-c C-x
1217 @findex foldout-exit-fold
1218   To unzoom (exit) a fold, use @kbd{C-c C-x} (@kbd{M-x foldout-exit-fold}).
1219 This hides all the text and subheadings under the top-level heading and
1220 returns you to the previous view of the buffer.  Specifying a numeric
1221 argument exits that many levels of folds.  Specifying a zero argument
1222 exits all folds.
1224   To cancel the narrowing of a fold without hiding the text and
1225 subheadings, specify a negative argument.  For example, @kbd{M--2 C-c
1226 C-x} exits two folds and leaves the text and subheadings exposed.
1228   Foldout mode also provides mouse commands for entering and exiting
1229 folds, and for showing and hiding text:
1231 @table @asis
1232 @item @kbd{C-M-Mouse-1} zooms in on the heading clicked on
1233 @itemize @asis
1234 @item
1235 single click: expose body.
1236 @item
1237 double click: expose subheadings.
1238 @item
1239 triple click: expose body and subheadings.
1240 @item
1241 quad click: expose entire subtree.
1242 @end itemize
1243 @item @kbd{C-M-Mouse-2} exposes text under the heading clicked on
1244 @itemize @asis
1245 @item
1246 single click: expose body.
1247 @item
1248 double click: expose subheadings.
1249 @item
1250 triple click: expose body and subheadings.
1251 @item
1252 quad click: expose entire subtree.
1253 @end itemize
1254 @item @kbd{C-M-Mouse-3} hides text under the heading clicked on or exits fold
1255 @itemize @asis
1256 @item
1257 single click: hide subtree.
1258 @item
1259 double click: exit fold and hide text.
1260 @item
1261 triple click: exit fold without hiding text.
1262 @item
1263 quad click: exit all folds and hide text.
1264 @end itemize
1265 @end table
1267 @vindex foldout-mouse-modifiers
1268   You can specify different modifier keys (instead of
1269 @kbd{Control-Meta-}) by setting @code{foldout-mouse-modifiers}; but if
1270 you have already loaded the @file{foldout.el} library, you must reload
1271 it in order for this to take effect.
1273   To use the Foldout package, you can type @kbd{M-x load-library
1274 @key{RET} foldout @key{RET}}; or you can arrange for to do that
1275 automatically by putting this in your @file{.emacs} file:
1277 @example
1278 (eval-after-load "outline" '(require 'foldout))
1279 @end example
1281 @node TeX Mode
1282 @section @TeX{} Mode
1283 @cindex @TeX{} mode
1284 @cindex La@TeX{} mode
1285 @cindex Sli@TeX{} mode
1286 @cindex mode, @TeX{}
1287 @cindex mode, La@TeX{}
1288 @cindex mode, Sli@TeX{}
1289 @findex tex-mode
1290 @findex plain-tex-mode
1291 @findex latex-mode
1292 @findex slitex-mode
1294   @TeX{} is a powerful text formatter written by Donald Knuth; it is also
1295 free, like GNU Emacs.  La@TeX{} is a simplified input format for @TeX{},
1296 implemented by @TeX{} macros; it comes with @TeX{}.  Sli@TeX{} is a special
1297 form of La@TeX{}.@footnote{Sli@TeX{} is obsoleted by the @samp{slides}
1298 document class in recent La@TeX{} versions.}
1300   Emacs has a special @TeX{} mode for editing @TeX{} input files.
1301 It provides facilities for checking the balance of delimiters and for
1302 invoking @TeX{} on all or part of the file.
1304 @vindex tex-default-mode
1305   @TeX{} mode has three variants, Plain @TeX{} mode, La@TeX{} mode, and
1306 Sli@TeX{} mode (these three distinct major modes differ only slightly).
1307 They are designed for editing the three different formats.  The command
1308 @kbd{M-x tex-mode} looks at the contents of the buffer to determine
1309 whether the contents appear to be either La@TeX{} input or Sli@TeX{}
1310 input; if so, it selects the appropriate mode.  If the file contents do
1311 not appear to be La@TeX{} or Sli@TeX{}, it selects Plain @TeX{} mode.
1312 If the contents are insufficient to determine this, the variable
1313 @code{tex-default-mode} controls which mode is used.
1315   When @kbd{M-x tex-mode} does not guess right, you can use the commands
1316 @kbd{M-x plain-tex-mode}, @kbd{M-x latex-mode}, and @kbd{M-x
1317 slitex-mode} to select explicitly the particular variants of @TeX{}
1318 mode.
1320 @menu
1321 * Editing: TeX Editing.   Special commands for editing in TeX mode.
1322 * LaTeX: LaTeX Editing.   Additional commands for LaTeX input files.
1323 * Printing: TeX Print.    Commands for printing part of a file with TeX.
1324 * Misc: TeX Misc.         Customization of TeX mode, and related features.
1325 @end menu
1327 @node TeX Editing
1328 @subsection @TeX{} Editing Commands
1330   Here are the special commands provided in @TeX{} mode for editing the
1331 text of the file.
1333 @table @kbd
1334 @item "
1335 Insert, according to context, either @samp{``} or @samp{"} or
1336 @samp{''} (@code{tex-insert-quote}).
1337 @item C-j
1338 Insert a paragraph break (two newlines) and check the previous
1339 paragraph for unbalanced braces or dollar signs
1340 (@code{tex-terminate-paragraph}).
1341 @item M-x tex-validate-region
1342 Check each paragraph in the region for unbalanced braces or dollar signs.
1343 @item C-c @{
1344 Insert @samp{@{@}} and position point between them (@code{tex-insert-braces}).
1345 @item C-c @}
1346 Move forward past the next unmatched close brace (@code{up-list}).
1347 @end table
1349 @findex tex-insert-quote
1350 @kindex " @r{(@TeX{} mode)}
1351   In @TeX{}, the character @samp{"} is not normally used; we use
1352 @samp{``} to start a quotation and @samp{''} to end one.  To make
1353 editing easier under this formatting convention, @TeX{} mode overrides
1354 the normal meaning of the key @kbd{"} with a command that inserts a pair
1355 of single-quotes or backquotes (@code{tex-insert-quote}).  To be
1356 precise, this command inserts @samp{``} after whitespace or an open
1357 brace, @samp{"} after a backslash, and @samp{''} after any other
1358 character.
1360   If you need the character @samp{"} itself in unusual contexts, use
1361 @kbd{C-q} to insert it.  Also, @kbd{"} with a numeric argument always
1362 inserts that number of @samp{"} characters.  You can turn off the
1363 feature of @kbd{"} expansion by eliminating that binding in the local
1364 map (@pxref{Key Bindings}).
1366   In @TeX{} mode, @samp{$} has a special syntax code which attempts to
1367 understand the way @TeX{} math mode delimiters match.  When you insert a
1368 @samp{$} that is meant to exit math mode, the position of the matching
1369 @samp{$} that entered math mode is displayed for a second.  This is the
1370 same feature that displays the open brace that matches a close brace that
1371 is inserted.  However, there is no way to tell whether a @samp{$} enters
1372 math mode or leaves it; so when you insert a @samp{$} that enters math
1373 mode, the previous @samp{$} position is shown as if it were a match, even
1374 though they are actually unrelated.
1376 @findex tex-insert-braces
1377 @kindex C-c @{ @r{(@TeX{} mode)}
1378 @findex up-list
1379 @kindex C-c @} @r{(@TeX{} mode)}
1380   @TeX{} uses braces as delimiters that must match.  Some users prefer
1381 to keep braces balanced at all times, rather than inserting them
1382 singly.  Use @kbd{C-c @{} (@code{tex-insert-braces}) to insert a pair of
1383 braces.  It leaves point between the two braces so you can insert the
1384 text that belongs inside.  Afterward, use the command @kbd{C-c @}}
1385 (@code{up-list}) to move forward past the close brace.
1387 @findex tex-validate-region
1388 @findex tex-terminate-paragraph
1389 @kindex C-j @r{(@TeX{} mode)}
1390   There are two commands for checking the matching of braces.  @kbd{C-j}
1391 (@code{tex-terminate-paragraph}) checks the paragraph before point, and
1392 inserts two newlines to start a new paragraph.  It outputs a message in
1393 the echo area if any mismatch is found.  @kbd{M-x tex-validate-region}
1394 checks a region, paragraph by paragraph.  The errors are listed in the
1395 @samp{*Occur*} buffer, and you can use @kbd{C-c C-c} or @kbd{Mouse-2} in
1396 that buffer to go to a particular mismatch.
1398   Note that Emacs commands count square brackets and parentheses in
1399 @TeX{} mode, not just braces.  This is not strictly correct for the
1400 purpose of checking @TeX{} syntax.  However, parentheses and square
1401 brackets are likely to be used in text as matching delimiters and it is
1402 useful for the various motion commands and automatic match display to
1403 work with them.
1405 @node LaTeX Editing
1406 @subsection La@TeX{} Editing Commands
1408   La@TeX{} mode, and its variant, Sli@TeX{} mode, provide a few extra
1409 features not applicable to plain @TeX{}.
1411 @table @kbd
1412 @item C-c C-o
1413 Insert @samp{\begin} and @samp{\end} for La@TeX{} block and position
1414 point on a line between them (@code{tex-latex-block}).
1415 @item C-c C-e
1416 Close the innermost La@TeX{} block not yet closed
1417 (@code{tex-close-latex-block}).
1418 @end table
1420 @findex tex-latex-block
1421 @kindex C-c C-o @r{(La@TeX{} mode)}
1422 @vindex latex-block-names
1423   In La@TeX{} input, @samp{\begin} and @samp{\end} commands are used to
1424 group blocks of text.  To insert a @samp{\begin} and a matching
1425 @samp{\end} (on a new line following the @samp{\begin}), use @kbd{C-c
1426 C-o} (@code{tex-latex-block}).  A blank line is inserted between the
1427 two, and point is left there.  You can use completion when you enter the
1428 block type; to specify additional block type names beyond the standard
1429 list, set the variable @code{latex-block-names}.  For example, here's
1430 how to add @samp{theorem}, @samp{corollary}, and @samp{proof}:
1432 @example
1433 (setq latex-block-names '("theorem" "corollary" "proof"))
1434 @end example
1436 @findex tex-close-latex-block
1437 @kindex C-c C-e @r{(La@TeX{} mode)}
1438   In La@TeX{} input, @samp{\begin} and @samp{\end} commands must
1439 balance.  You can use @kbd{C-c C-e} (@code{tex-close-latex-block}) to
1440 insert automatically a matching @samp{\end} to match the last unmatched
1441 @samp{\begin}.  It indents the @samp{\end} to match the corresponding
1442 @samp{\begin}.  It inserts a newline after @samp{\end} if point is at
1443 the beginning of a line.
1445 @node TeX Print
1446 @subsection @TeX{} Printing Commands
1448   You can invoke @TeX{} as an inferior of Emacs on either the entire
1449 contents of the buffer or just a region at a time.  Running @TeX{} in
1450 this way on just one chapter is a good way to see what your changes
1451 look like without taking the time to format the entire file.
1453 @table @kbd
1454 @item C-c C-r
1455 Invoke @TeX{} on the current region, together with the buffer's header
1456 (@code{tex-region}).
1457 @item C-c C-b
1458 Invoke @TeX{} on the entire current buffer (@code{tex-buffer}).
1459 @item C-c @key{TAB}
1460 Invoke Bib@TeX{} on the current file (@code{tex-bibtex-file}).
1461 @item C-c C-f
1462 Invoke @TeX{} on the current file (@code{tex-file}).
1463 @item C-c C-l
1464 Recenter the window showing output from the inferior @TeX{} so that
1465 the last line can be seen (@code{tex-recenter-output-buffer}).
1466 @item C-c C-k
1467 Kill the @TeX{} subprocess (@code{tex-kill-job}).
1468 @item C-c C-p
1469 Print the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c
1470 C-f} command (@code{tex-print}).
1471 @item C-c C-v
1472 Preview the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c
1473 C-f} command (@code{tex-view}).
1474 @item C-c C-q
1475 Show the printer queue (@code{tex-show-print-queue}).
1476 @end table
1478 @findex tex-buffer
1479 @kindex C-c C-b @r{(@TeX{} mode)}
1480 @findex tex-print
1481 @kindex C-c C-p @r{(@TeX{} mode)}
1482 @findex tex-view
1483 @kindex C-c C-v @r{(@TeX{} mode)}
1484 @findex tex-show-print-queue
1485 @kindex C-c C-q @r{(@TeX{} mode)}
1486   You can pass the current buffer through an inferior @TeX{} by means of
1487 @kbd{C-c C-b} (@code{tex-buffer}).  The formatted output appears in a
1488 temporary file; to print it, type @kbd{C-c C-p} (@code{tex-print}).
1489 Afterward, you can use @kbd{C-c C-q} (@code{tex-show-print-queue}) to
1490 view the progress of your output towards being printed.  If your terminal
1491 has the ability to display @TeX{} output files, you can preview the
1492 output on the terminal with @kbd{C-c C-v} (@code{tex-view}).
1494 @cindex @env{TEXINPUTS} environment variable
1495 @vindex tex-directory
1496   You can specify the directory to use for running @TeX{} by setting the
1497 variable @code{tex-directory}.  @code{"."} is the default value.  If
1498 your environment variable @env{TEXINPUTS} contains relative directory
1499 names, or if your files contains @samp{\input} commands with relative
1500 file names, then @code{tex-directory} @emph{must} be @code{"."} or you
1501 will get the wrong results.  Otherwise, it is safe to specify some other
1502 directory, such as @code{"/tmp"}.
1504 @vindex tex-run-command
1505 @vindex latex-run-command
1506 @vindex slitex-run-command
1507 @vindex tex-dvi-print-command
1508 @vindex tex-dvi-view-command
1509 @vindex tex-show-queue-command
1510   If you want to specify which shell commands are used in the inferior @TeX{},
1511 you can do so by setting the values of the variables @code{tex-run-command},
1512 @code{latex-run-command}, @code{slitex-run-command},
1513 @code{tex-dvi-print-command}, @code{tex-dvi-view-command}, and
1514 @code{tex-show-queue-command}.  You @emph{must} set the value of
1515 @code{tex-dvi-view-command} for your particular terminal; this variable
1516 has no default value.  The other variables have default values that may
1517 (or may not) be appropriate for your system.
1519   Normally, the file name given to these commands comes at the end of
1520 the command string; for example, @samp{latex @var{filename}}.  In some
1521 cases, however, the file name needs to be embedded in the command; an
1522 example is when you need to provide the file name as an argument to one
1523 command whose output is piped to another.  You can specify where to put
1524 the file name with @samp{*} in the command string.  For example,
1526 @example
1527 (setq tex-dvi-print-command "dvips -f * | lpr")
1528 @end example
1530 @findex tex-kill-job
1531 @kindex C-c C-k @r{(@TeX{} mode)}
1532 @findex tex-recenter-output-buffer
1533 @kindex C-c C-l @r{(@TeX{} mode)}
1534   The terminal output from @TeX{}, including any error messages, appears
1535 in a buffer called @samp{*tex-shell*}.  If @TeX{} gets an error, you can
1536 switch to this buffer and feed it input (this works as in Shell mode;
1537 @pxref{Interactive Shell}).  Without switching to this buffer you can
1538 scroll it so that its last line is visible by typing @kbd{C-c
1539 C-l}.
1541   Type @kbd{C-c C-k} (@code{tex-kill-job}) to kill the @TeX{} process if
1542 you see that its output is no longer useful.  Using @kbd{C-c C-b} or
1543 @kbd{C-c C-r} also kills any @TeX{} process still running.@refill
1545 @findex tex-region
1546 @kindex C-c C-r @r{(@TeX{} mode)}
1547   You can also pass an arbitrary region through an inferior @TeX{} by typing
1548 @kbd{C-c C-r} (@code{tex-region}).  This is tricky, however, because most files
1549 of @TeX{} input contain commands at the beginning to set parameters and
1550 define macros, without which no later part of the file will format
1551 correctly.  To solve this problem, @kbd{C-c C-r} allows you to designate a
1552 part of the file as containing essential commands; it is included before
1553 the specified region as part of the input to @TeX{}.  The designated part
1554 of the file is called the @dfn{header}.
1556 @cindex header (@TeX{} mode)
1557   To indicate the bounds of the header in Plain @TeX{} mode, you insert two
1558 special strings in the file.  Insert @samp{%**start of header} before the
1559 header, and @samp{%**end of header} after it.  Each string must appear
1560 entirely on one line, but there may be other text on the line before or
1561 after.  The lines containing the two strings are included in the header.
1562 If @samp{%**start of header} does not appear within the first 100 lines of
1563 the buffer, @kbd{C-c C-r} assumes that there is no header.
1565   In La@TeX{} mode, the header begins with @samp{\documentclass} or
1566 @samp{\documentstyle} and ends with @samp{\begin@{document@}}.  These
1567 are commands that La@TeX{} requires you to use in any case, so nothing
1568 special needs to be done to identify the header.
1570 @findex tex-file
1571 @kindex C-c C-f @r{(@TeX{} mode)}
1572   The commands (@code{tex-buffer}) and (@code{tex-region}) do all of their
1573 work in a temporary directory, and do not have available any of the auxiliary
1574 files needed by @TeX{} for cross-references; these commands are generally
1575 not suitable for running the final copy in which all of the cross-references
1576 need to be correct.
1578   When you want the auxiliary files for cross references, use @kbd{C-c
1579 C-f} (@code{tex-file}) which runs @TeX{} on the current buffer's file,
1580 in that file's directory.  Before running @TeX{}, it offers to save any
1581 modified buffers.  Generally, you need to use (@code{tex-file}) twice to
1582 get the cross-references right.
1584 @vindex tex-start-options
1585   The value of the variable @code{tex-start-options} specifies
1586 options for the @TeX{} run.
1588 @vindex tex-start-commands
1589   The value of the variable @code{tex-start-commands} specifies @TeX{}
1590 commands for starting @TeX{}.  The default value causes @TeX{} to run
1591 in nonstop mode.  To run @TeX{} interactively, set the variable to
1592 @code{""}.
1594 @vindex tex-main-file
1595   Large @TeX{} documents are often split into several files---one main
1596 file, plus subfiles.  Running @TeX{} on a subfile typically does not
1597 work; you have to run it on the main file.  In order to make
1598 @code{tex-file} useful when you are editing a subfile, you can set the
1599 variable @code{tex-main-file} to the name of the main file.  Then
1600 @code{tex-file} runs @TeX{} on that file.
1602   The most convenient way to use @code{tex-main-file} is to specify it
1603 in a local variable list in each of the subfiles.  @xref{File
1604 Variables}.
1606 @findex tex-bibtex-file
1607 @kindex C-c TAB @r{(@TeX{} mode)}
1608 @vindex tex-bibtex-command
1609   For La@TeX{} files, you can use Bib@TeX{} to process the auxiliary
1610 file for the current buffer's file.  Bib@TeX{} looks up bibliographic
1611 citations in a data base and prepares the cited references for the
1612 bibliography section.  The command @kbd{C-c TAB}
1613 (@code{tex-bibtex-file}) runs the shell command
1614 (@code{tex-bibtex-command}) to produce a @samp{.bbl} file for the
1615 current buffer's file.  Generally, you need to do @kbd{C-c C-f}
1616 (@code{tex-file}) once to generate the @samp{.aux} file, then do
1617 @kbd{C-c TAB} (@code{tex-bibtex-file}), and then repeat @kbd{C-c C-f}
1618 (@code{tex-file}) twice more to get the cross-references correct.
1620 @node TeX Misc
1621 @subsection @TeX{} Mode Miscellany
1623 @vindex tex-shell-hook
1624 @vindex tex-mode-hook
1625 @vindex latex-mode-hook
1626 @vindex slitex-mode-hook
1627 @vindex plain-tex-mode-hook
1628   Entering any variant of @TeX{} mode runs the hooks
1629 @code{text-mode-hook} and @code{tex-mode-hook}.  Then it runs either
1630 @code{plain-tex-mode-hook}, @code{latex-mode-hook}, or
1631 @code{slitex-mode-hook}, whichever is appropriate.  Starting the
1632 @TeX{} shell runs the hook @code{tex-shell-hook}.  @xref{Hooks}.
1634 @findex iso-iso2tex
1635 @findex iso-tex2iso
1636 @findex iso-iso2gtex
1637 @findex iso-gtex2iso
1638 @cindex Latin-1 @TeX{} encoding
1639 @cindex @TeX{} encoding
1640   The commands @kbd{M-x iso-iso2tex}, @kbd{M-x iso-tex2iso}, @kbd{M-x
1641 iso-iso2gtex} and @kbd{M-x iso-gtex2iso} can be used to convert
1642 between Latin-1 encoded files and @TeX{}-encoded equivalents.
1643 @ignore
1644 @c Too cryptic to be useful, too cryptic for me to make it better -- rms.
1645   They
1646 are included by default in the @code{format-alist} variable, so they
1647 can be used with @kbd{M-x format-find-file}, for instance.
1648 @end ignore
1650 @ignore  @c Not worth documenting if it is only for Czech -- rms.
1651 @findex tildify-buffer
1652 @findex tildify-region
1653 @cindex ties, @TeX{}, inserting
1654 @cindex hard spaces, @TeX{}, inserting
1655   The commands @kbd{M-x tildify-buffer} and @kbd{M-x tildify-region}
1656 insert @samp{~} (@dfn{tie}) characters where they are conventionally
1657 required.  This is set up for Czech---customize the group
1658 @samp{tildify} for other languages or for other sorts of markup.
1659 @end ignore
1661 @cindex Ref@TeX{} package
1662 @cindex references, La@TeX{}
1663 @cindex La@TeX{} references
1664   For managing all kinds of references for La@TeX{}, you can use
1665 Ref@TeX{}.  @inforef{Top,, reftex}.
1667 @node HTML Mode
1668 @section SGML, XML, and HTML Modes
1670   The major modes for SGML and HTML include indentation support and
1671 commands to operate on tags.  This section describes the special
1672 commands of these modes.  (HTML mode is a slightly customized variant
1673 of SGML mode.)
1675 @table @kbd
1676 @item C-c C-n
1677 @kindex C-c C-n @r{(SGML mode)}
1678 @findex sgml-name-char
1679 Interactively specify a special character and insert the SGML
1680 @samp{&}-command for that character.
1682 @item C-c C-t
1683 @kindex C-c C-t @r{(SGML mode)}
1684 @findex sgml-tag
1685 Interactively specify a tag and its attributes (@code{sgml-tag}).
1686 This command asks you for a tag name and for the attribute values,
1687 then inserts both the opening tag and the closing tag, leaving point
1688 between them.
1690 With a prefix argument @var{n}, the command puts the tag around the
1691 @var{n} words already present in the buffer after point.  With
1692 @minus{}1 as argument, it puts the tag around the region.  (In
1693 Transient Mark mode, it does this whenever a region is active.)
1695 @item C-c C-a
1696 @kindex C-c C-a @r{(SGML mode)}
1697 @findex sgml-attributes
1698 Interactively insert attribute values for the current tag
1699 (@code{sgml-attributes}).
1701 @item C-c C-f
1702 @kindex C-c C-f @r{(SGML mode)}
1703 @findex sgml-skip-tag-forward
1704 Skip across a balanced tag group (which extends from an opening tag
1705 through its corresponding closing tag) (@code{sgml-skip-tag-forward}).
1706 A numeric argument acts as a repeat count.
1708 @item C-c C-b
1709 @kindex C-c C-b @r{(SGML mode)}
1710 @findex sgml-skip-tag-backward
1711 Skip backward across a balanced tag group (which extends from an
1712 opening tag through its corresponding closing tag)
1713 (@code{sgml-skip-tag-forward}).  A numeric argument acts as a repeat
1714 count.
1716 @item C-c C-d
1717 @kindex C-c C-d @r{(SGML mode)}
1718 @findex sgml-delete-tag
1719 Delete the tag at or after point, and delete the matching tag too
1720 (@code{sgml-delete-tag}).  If the tag at or after point is an opening
1721 tag, delete the closing tag too; if it is a closing tag, delete the
1722 opening tag too.
1724 @item C-c ? @var{tag} @key{RET}
1725 @kindex C-c ? @r{(SGML mode)}
1726 @findex sgml-tag-help
1727 Display a description of the meaning of tag @var{tag}
1728 (@code{sgml-tag-help}).  If the argument @var{tag} is empty, describe
1729 the tag at point.
1731 @item C-c /
1732 @kindex C-c / @r{(SGML mode)}
1733 @findex sgml-close-tag
1734 Insert a close tag for the innermost unterminated tag
1735 (@code{sgml-close-tag}).  If called from within a tag or a comment,
1736 close this element instead of inserting a close tag.
1738 @item C-c 8
1739 @kindex C-c 8 @r{(SGML mode)}
1740 @findex sgml-name-8bit-mode
1741 Toggle a minor mode in which Latin-1 characters insert the
1742 corresponding SGML commands that stand for them, instead of the
1743 characters themselves (@code{sgml-name-8bit-mode}).
1745 @item C-c C-v
1746 @kindex C-c C-v @r{(SGML mode)}
1747 @findex sgml-validate
1748 Run a shell command (which you must specify) to validate the current
1749 buffer as SGML (@code{sgml-validate}).
1751 @item C-x TAB
1752 @kindex C-c TAB @r{(SGML mode)}
1753 @findex sgml-tags-invisible
1754 Toggle the visibility of existing tags in the buffer.  This can be
1755 used as a cheap preview.
1756 @end table
1758 @vindex sgml-xml-mode
1759   SGML mode and HTML mode support XML also.  In XML, every opening tag
1760 must have an explicit closing tag.  When @code{sgml-xml-mode} is
1761 non-@code{nil}, SGML mode (and HTML mode) always insert explicit
1762 closing tags.  When you visit a file, these modes determine from the
1763 file contents whether it is XML or not, and set @code{sgml-xml-mode}
1764 accordingly, so that they do the right thing for the file in either
1765 case.
1767 @node Nroff Mode
1768 @section Nroff Mode
1770 @cindex nroff
1771 @findex nroff-mode
1772   Nroff mode is a mode like Text mode but modified to handle nroff commands
1773 present in the text.  Invoke @kbd{M-x nroff-mode} to enter this mode.  It
1774 differs from Text mode in only a few ways.  All nroff command lines are
1775 considered paragraph separators, so that filling will never garble the
1776 nroff commands.  Pages are separated by @samp{.bp} commands.  Comments
1777 start with backslash-doublequote.  Also, three special commands are
1778 provided that are not in Text mode:
1780 @findex forward-text-line
1781 @findex backward-text-line
1782 @findex count-text-lines
1783 @kindex M-n @r{(Nroff mode)}
1784 @kindex M-p @r{(Nroff mode)}
1785 @kindex M-? @r{(Nroff mode)}
1786 @table @kbd
1787 @item M-n
1788 Move to the beginning of the next line that isn't an nroff command
1789 (@code{forward-text-line}).  An argument is a repeat count.
1790 @item M-p
1791 Like @kbd{M-n} but move up (@code{backward-text-line}).
1792 @item M-?
1793 Displays in the echo area the number of text lines (lines that are not
1794 nroff commands) in the region (@code{count-text-lines}).
1795 @end table
1797 @findex electric-nroff-mode
1798   The other feature of Nroff mode is that you can turn on Electric Nroff
1799 mode.  This is a minor mode that you can turn on or off with @kbd{M-x
1800 electric-nroff-mode} (@pxref{Minor Modes}).  When the mode is on, each
1801 time you use @key{RET} to end a line that contains an nroff command that
1802 opens a kind of grouping, the matching nroff command to close that
1803 grouping is automatically inserted on the following line.  For example,
1804 if you are at the beginning of a line and type @kbd{.@: ( b @key{RET}},
1805 this inserts the matching command @samp{.)b} on a new line following
1806 point.
1808   If you use Outline minor mode with Nroff mode (@pxref{Outline Mode}),
1809 heading lines are lines of the form @samp{.H} followed by a number (the
1810 header level).
1812 @vindex nroff-mode-hook
1813   Entering Nroff mode runs the hook @code{text-mode-hook}, followed by
1814 the hook @code{nroff-mode-hook} (@pxref{Hooks}).
1816 @node Formatted Text
1817 @section Editing Formatted Text
1819 @cindex Enriched mode
1820 @cindex mode, Enriched
1821 @cindex formatted text
1822 @cindex WYSIWYG
1823 @cindex word processing
1824   @dfn{Enriched mode} is a minor mode for editing files that contain
1825 formatted text in WYSIWYG fashion, as in a word processor.  Currently,
1826 formatted text in Enriched mode can specify fonts, colors, underlining,
1827 margins, and types of filling and justification.  In the future, we plan
1828 to implement other formatting features as well.
1830   Enriched mode is a minor mode (@pxref{Minor Modes}).  It is
1831 typically used in conjunction with Text mode (@pxref{Text Mode}), but
1832 you can also use it with other major modes such as Outline mode and
1833 Paragraph-Indent Text mode.
1835 @cindex text/enriched MIME format
1836   Potentially, Emacs can store formatted text files in various file
1837 formats.  Currently, only one format is implemented: @dfn{text/enriched}
1838 format, which is defined by the MIME protocol.  @xref{Format
1839 Conversion,, Format Conversion, elisp, the Emacs Lisp Reference Manual},
1840 for details of how Emacs recognizes and converts file formats.
1842   The Emacs distribution contains a formatted text file that can serve as
1843 an example.  Its name is @file{etc/enriched.doc}.  It contains samples
1844 illustrating all the features described in this section.  It also
1845 contains a list of ideas for future enhancements.
1847 @menu
1848 * Requesting Formatted Text::   Entering and exiting Enriched mode.
1849 * Hard and Soft Newlines::      There are two different kinds of newlines.
1850 * Editing Format Info::         How to edit text properties.
1851 * Faces: Format Faces.          Bold, italic, underline, etc.
1852 * Color: Format Colors.         Changing the color of text.
1853 * Indent: Format Indentation.   Changing the left and right margins.
1854 * Justification: Format Justification.
1855                                 Centering, setting text flush with the
1856                                   left or right margin, etc.
1857 * Other: Format Properties.     The "special" text properties submenu.
1858 * Forcing Enriched Mode::       How to force use of Enriched mode.
1859 @end menu
1861 @node Requesting Formatted Text
1862 @subsection Requesting to Edit Formatted Text
1864   Whenever you visit a file that Emacs saved in the text/enriched
1865 format, Emacs automatically converts the formatting information in the
1866 file into Emacs's own internal format (known as @dfn{text
1867 properties}), and turns on Enriched mode.
1869 @findex enriched-mode
1870   To create a new file of formatted text, first visit the nonexistent
1871 file, then type @kbd{M-x enriched-mode} before you start inserting text.
1872 This command turns on Enriched mode.  Do this before you begin inserting
1873 text, to ensure that the text you insert is handled properly.
1875   More generally, the command @code{enriched-mode} turns Enriched mode
1876 on if it was off, and off if it was on.  With a prefix argument, this
1877 command turns Enriched mode on if the argument is positive, and turns
1878 the mode off otherwise.
1880   When you save a buffer while Enriched mode is enabled in it, Emacs
1881 automatically converts the text to text/enriched format while writing it
1882 into the file.  When you visit the file again, Emacs will automatically
1883 recognize the format, reconvert the text, and turn on Enriched mode
1884 again.
1886 @vindex enriched-translations
1887   You can add annotations for saving additional text properties, which
1888 Emacs normally does not save, by adding to @code{enriched-translations}.
1889 Note that the text/enriched standard requires any non-standard
1890 annotations to have names starting with @samp{x-}, as in
1891 @samp{x-read-only}.  This ensures that they will not conflict with
1892 standard annotations that may be added later.
1894   @xref{Text Properties,,, elisp, the Emacs Lisp Reference Manual},
1895 for more information about text properties.
1897 @node Hard and Soft Newlines
1898 @subsection Hard and Soft Newlines
1899 @cindex hard newline
1900 @cindex soft newline
1901 @cindex newlines, hard and soft
1903   In formatted text, Emacs distinguishes between two different kinds of
1904 newlines, @dfn{hard} newlines and @dfn{soft} newlines.
1906   Hard newlines are used to separate paragraphs, or items in a list, or
1907 anywhere that there should always be a line break regardless of the
1908 margins.  The @key{RET} command (@code{newline}) and @kbd{C-o}
1909 (@code{open-line}) insert hard newlines.
1911   Soft newlines are used to make text fit between the margins.  All the
1912 fill commands, including Auto Fill, insert soft newlines---and they
1913 delete only soft newlines.
1915   Although hard and soft newlines look the same, it is important to bear
1916 the difference in mind.  Do not use @key{RET} to break lines in the
1917 middle of filled paragraphs, or else you will get hard newlines that are
1918 barriers to further filling.  Instead, let Auto Fill mode break lines,
1919 so that if the text or the margins change, Emacs can refill the lines
1920 properly.  @xref{Auto Fill}.
1922   On the other hand, in tables and lists, where the lines should always
1923 remain as you type them, you can use @key{RET} to end lines.  For these
1924 lines, you may also want to set the justification style to
1925 @code{unfilled}.  @xref{Format Justification}.
1927 @node Editing Format Info
1928 @subsection Editing Format Information
1930   There are two ways to alter the formatting information for a formatted
1931 text file: with keyboard commands, and with the mouse.
1933   The easiest way to add properties to your document is with the Text
1934 Properties menu.  You can get to this menu in two ways: from the Edit
1935 menu in the menu bar (use @kbd{@key{F10} e t} if you have no mouse),
1936 or with @kbd{C-Mouse-2} (hold the @key{CTRL} key and press the middle
1937 mouse button).  There are also keyboard commands described in the
1938 following section.
1940   Most of the items in the Text Properties menu lead to other submenus.
1941 These are described in the sections that follow.  Some items run
1942 commands directly:
1944 @table @code
1945 @findex facemenu-remove-face-props
1946 @item Remove Face Properties
1947 Delete from the region all face and color text properties
1948 (@code{facemenu-remove-face-props}).
1950 @findex facemenu-remove-all
1951 @item Remove Text Properties
1952 Delete @emph{all} text properties from the region
1953 (@code{facemenu-remove-all}).
1955 @findex describe-text-properties
1956 @cindex text properties of characters
1957 @cindex overlays at character position
1958 @cindex widgets at buffer position
1959 @cindex buttons at buffer position
1960 @item Describe Properties
1961 List all the text properties, widgets, buttons, and overlays of the
1962 character following point (@code{describe-text-properties}).
1964 @item Display Faces
1965 Display a list of all the defined faces (@code{list-faces-display}).
1967 @item Display Colors
1968 Display a list of all the defined colors (@code{list-colors-display}).
1969 @end table
1971 @node Format Faces
1972 @subsection Faces in Formatted Text
1974   The Faces submenu lists various Emacs faces including @code{bold},
1975 @code{italic}, and @code{underline}.  Selecting one of these adds the
1976 chosen face to the region.  @xref{Faces}.  You can also specify a face
1977 with these keyboard commands:
1979 @table @kbd
1980 @kindex M-g d @r{(Enriched mode)}
1981 @findex facemenu-set-default
1982 @item M-g d
1983 Set the region, or the next inserted character, to the @code{default} face
1984 (@code{facemenu-set-default}).
1985 @kindex M-g b @r{(Enriched mode)}
1986 @findex facemenu-set-bold
1987 @item M-g b
1988 Set the region, or the next inserted character, to the @code{bold} face
1989 (@code{facemenu-set-bold}).
1990 @kindex M-g i @r{(Enriched mode)}
1991 @findex facemenu-set-italic
1992 @item M-g i
1993 Set the region, or the next inserted character, to the @code{italic} face
1994 (@code{facemenu-set-italic}).
1995 @kindex M-g l @r{(Enriched mode)}
1996 @findex facemenu-set-bold-italic
1997 @item M-g l
1998 Set the region, or the next inserted character, to the @code{bold-italic} face
1999 (@code{facemenu-set-bold-italic}).
2000 @kindex M-g u @r{(Enriched mode)}
2001 @findex facemenu-set-underline
2002 @item M-g u
2003 Set the region, or the next inserted character, to the @code{underline} face
2004 (@code{facemenu-set-underline}).
2005 @kindex M-g o @r{(Enriched mode)}
2006 @findex facemenu-set-face
2007 @item M-g o @var{face} @key{RET}
2008 Set the region, or the next inserted character, to the face @var{face}
2009 (@code{facemenu-set-face}).
2010 @end table
2012   If you use these commands with a prefix argument---or, in Transient Mark
2013 mode, if the region is not active---then these commands specify a face
2014 to use for any immediately following self-inserting input.
2015 @xref{Transient Mark}.  This applies to both the keyboard commands and
2016 the menu commands.
2018   Specifying the @code{default} face also resets foreground and
2019 background color to their defaults.(@pxref{Format Colors}).
2021   Any self-inserting character you type inherits, by default, the face
2022 properties (as well as most other text properties) of the preceding
2023 character.  Specifying any face property, including foreground or
2024 background color, for your next self-inserting character will prevent
2025 it from inheriting any face properties from the preceding character,
2026 although it will still inherit other text properties.  Characters
2027 inserted by yanking do not inherit text properties.
2029   Enriched mode defines two additional faces: @code{excerpt} and
2030 @code{fixed}.  These correspond to codes used in the text/enriched file
2031 format.
2033   The @code{excerpt} face is intended for quotations.  This face is the
2034 same as @code{italic} unless you customize it (@pxref{Face Customization}).
2036   The @code{fixed} face means, ``Use a fixed-width font for this part
2037 of the text.''  Applying the @code{fixed} face to a part of the text
2038 will cause that part of the text to appear in a fixed-width font, even
2039 if the default font is variable-width.  This applies to Emacs and to
2040 other systems that display text/enriched format.  So if you
2041 specifically want a certain part of the text to use a fixed-width
2042 font, you should specify the @code{fixed} face for that part.
2044   By default, the @code{fixed} face looks the same as @code{bold}.
2045 This is an attempt to distinguish it from @code{default}.  You may
2046 wish to customize @code{fixed} to some other fixed-width medium font.
2047 @xref{Face Customization}.
2049   If your terminal cannot display different faces, you will not be
2050 able to see them, but you can still edit documents containing faces,
2051 and even add faces and colors to documents.  The faces you specify
2052 will be visible when the file is viewed on a terminal that can display
2053 them.
2055 @node Format Colors
2056 @subsection Colors in Formatted Text
2058   You can specify foreground and background colors for portions of the
2059 text.  There is a menu for specifying the foreground color and a menu
2060 for specifying the background color.  Each color menu lists all the
2061 colors that you have used in Enriched mode in the current Emacs session.
2063   If you specify a color with a prefix argument---or, in Transient
2064 Mark mode, if the region is not active---then it applies to any
2065 immediately following self-inserting input.  @xref{Transient Mark}.
2066 Otherwise, the command applies to the region.
2068   Each color menu contains one additional item: @samp{Other}.  You can use
2069 this item to specify a color that is not listed in the menu; it reads
2070 the color name with the minibuffer.  To display a list of available colors
2071 and their names, use the @samp{Display Colors} menu item in the Text
2072 Properties menu (@pxref{Editing Format Info}).
2074   Any color that you specify in this way, or that is mentioned in a
2075 formatted text file that you read in, is added to the corresponding
2076 color menu for the duration of the Emacs session.
2078 @findex facemenu-set-foreground
2079 @findex facemenu-set-background
2080   There are no key bindings for specifying colors, but you can do so
2081 with the extended commands @kbd{M-x facemenu-set-foreground} and
2082 @kbd{M-x facemenu-set-background}.  Both of these commands read the name
2083 of the color with the minibuffer.
2085 @node Format Indentation
2086 @subsection Indentation in Formatted Text
2088   When editing formatted text, you can specify different amounts of
2089 indentation for the right or left margin of an entire paragraph or a
2090 part of a paragraph.  The margins you specify automatically affect the
2091 Emacs fill commands (@pxref{Filling}) and line-breaking commands.
2093   The Indentation submenu provides a convenient interface for specifying
2094 these properties.  The submenu contains four items:
2096 @table @code
2097 @kindex C-x TAB @r{(Enriched mode)}
2098 @findex increase-left-margin
2099 @item Indent More
2100 Indent the region by 4 columns (@code{increase-left-margin}).  In
2101 Enriched mode, this command is also available on @kbd{C-x @key{TAB}}; if
2102 you supply a numeric argument, that says how many columns to add to the
2103 margin (a negative argument reduces the number of columns).
2105 @item Indent Less
2106 Remove 4 columns of indentation from the region.
2108 @item Indent Right More
2109 Make the text narrower by indenting 4 columns at the right margin.
2111 @item Indent Right Less
2112 Remove 4 columns of indentation from the right margin.
2113 @end table
2115   You can use these commands repeatedly to increase or decrease the
2116 indentation.
2118   The most common way to use them is to change the indentation of an
2119 entire paragraph.  For other uses, the effects of refilling can be
2120 hard to predict, except in some special cases like the one described
2121 next.
2123   The most common other use is to format paragraphs with @dfn{hanging
2124 indents}, which means that the first line is indented less than
2125 subsequent lines.  To set up a hanging indent, increase the
2126 indentation of the region starting after the first word of the
2127 paragraph and running until the end of the paragraph.
2129   Indenting the first line of a paragraph is easier.  Set the margin for
2130 the whole paragraph where you want it to be for the body of the
2131 paragraph, then indent the first line by inserting extra spaces or tabs.
2133 @vindex standard-indent
2134   The variable @code{standard-indent} specifies how many columns these
2135 commands should add to or subtract from the indentation.  The default
2136 value is 4.  The overall default right margin for Enriched mode is
2137 controlled by the variable @code{fill-column}, as usual.
2139 @kindex C-c [ @r{(Enriched mode)}
2140 @kindex C-c ] @r{(Enriched mode)}
2141 @findex set-left-margin
2142 @findex set-right-margin
2143   There are also two commands for setting the left or right margin of
2144 the region absolutely: @code{set-left-margin} and
2145 @code{set-right-margin}.  Enriched mode binds these commands to
2146 @kbd{C-c [} and @kbd{C-c ]}, respectively.  You can specify the
2147 margin width either with a numeric argument or in the minibuffer.
2149   Sometimes, as a result of editing, the filling of a paragraph becomes
2150 messed up---parts of the paragraph may extend past the left or right
2151 margins.  When this happens, use @kbd{M-q} (@code{fill-paragraph}) to
2152 refill the paragraph.
2154   The fill prefix, if any, works in addition to the specified paragraph
2155 indentation: @kbd{C-x .} does not include the specified indentation's
2156 whitespace in the new value for the fill prefix, and the fill commands
2157 look for the fill prefix after the indentation on each line.  @xref{Fill
2158 Prefix}.
2160 @node Format Justification
2161 @subsection Justification in Formatted Text
2163   When editing formatted text, you can specify various styles of
2164 justification for a paragraph.  The style you specify automatically
2165 affects the Emacs fill commands.
2167   The Justification submenu provides a convenient interface for specifying
2168 the style.  The submenu contains five items:
2170 @table @code
2171 @item Left
2172 This is the most common style of justification (at least for English).
2173 Lines are aligned at the left margin but left uneven at the right.
2175 @item Right
2176 This aligns each line with the right margin.  Spaces and tabs are added
2177 on the left, if necessary, to make lines line up on the right.
2179 @item Full
2180 This justifies the text, aligning both edges of each line.  Justified
2181 text looks very nice in a printed book, where the spaces can all be
2182 adjusted equally, but it does not look as nice with a fixed-width font
2183 on the screen.  Perhaps a future version of Emacs will be able to adjust
2184 the width of spaces in a line to achieve elegant justification.
2186 @item Center
2187 This centers every line between the current margins.
2189 @item Unfilled
2190 This turns off filling entirely.  Each line will remain as you wrote it;
2191 the fill and auto-fill functions will have no effect on text which has
2192 this setting.  You can, however, still indent the left margin.  In
2193 unfilled regions, all newlines are treated as hard newlines (@pxref{Hard
2194 and Soft Newlines}) .
2195 @end table
2197   In Enriched mode, you can also specify justification from the keyboard
2198 using the @kbd{M-j} prefix character:
2200 @table @kbd
2201 @kindex M-j l @r{(Enriched mode)}
2202 @findex set-justification-left
2203 @item M-j l
2204 Make the region left-filled (@code{set-justification-left}).
2205 @kindex M-j r @r{(Enriched mode)}
2206 @findex set-justification-right
2207 @item M-j r
2208 Make the region right-filled (@code{set-justification-right}).
2209 @kindex M-j b @r{(Enriched mode)}
2210 @findex set-justification-full
2211 @item M-j b
2212 Make the region fully justified (@code{set-justification-full}).
2213 @kindex M-j c @r{(Enriched mode)}
2214 @kindex M-S @r{(Enriched mode)}
2215 @findex set-justification-center
2216 @item M-j c
2217 @itemx M-S
2218 Make the region centered (@code{set-justification-center}).
2219 @kindex M-j u @r{(Enriched mode)}
2220 @findex set-justification-none
2221 @item M-j u
2222 Make the region unfilled (@code{set-justification-none}).
2223 @end table
2225   Justification styles apply to entire paragraphs.  All the
2226 justification-changing commands operate on the paragraph containing
2227 point, or, if the region is active, on all paragraphs which overlap the
2228 region.
2230 @vindex default-justification
2231   The default justification style is specified by the variable
2232 @code{default-justification}.  Its value should be one of the symbols
2233 @code{left}, @code{right}, @code{full}, @code{center}, or @code{none}.
2234 This is a per-buffer variable.  Setting the variable directly affects
2235 only the current buffer.  However, customizing it in a Custom buffer
2236 sets (as always) the default value for buffers that do not override it.
2237 @xref{Locals}, and @ref{Easy Customization}.
2239 @node Format Properties
2240 @subsection Setting Other Text Properties
2242   The Special Properties menu lets you add or remove three other useful text
2243 properties: @code{read-only}, @code{invisible} and @code{intangible}.
2244 The @code{intangible} property disallows moving point within the text,
2245 the @code{invisible} text property hides text from display, and the
2246 @code{read-only} property disallows alteration of the text.
2248   Each of these special properties has a menu item to add it to the
2249 region.  The last menu item, @samp{Remove Special}, removes all of these
2250 special properties from the text in the region.
2252   Currently, the @code{invisible} and @code{intangible} properties are
2253 @emph{not} saved in the text/enriched format.  The @code{read-only}
2254 property is saved, but it is not a standard part of the text/enriched
2255 format, so other editors may not respect it.
2257 @node Forcing Enriched Mode
2258 @subsection Forcing Enriched Mode
2260   Normally, Emacs knows when you are editing formatted text because it
2261 recognizes the special annotations used in the file that you visited.
2262 However, there are situations in which you must take special actions
2263 to convert file contents or turn on Enriched mode:
2265 @itemize @bullet
2266 @item
2267 When you visit a file that was created with some other editor, Emacs may
2268 not recognize the file as being in the text/enriched format.  In this
2269 case, when you visit the file you will see the formatting commands
2270 rather than the formatted text.  Type @kbd{M-x format-decode-buffer} to
2271 translate it.  This also automatically turns on Enriched mode.
2273 @item
2274 When you @emph{insert} a file into a buffer, rather than visiting it,
2275 Emacs does the necessary conversions on the text which you insert, but
2276 it does not enable Enriched mode.  If you wish to do that, type @kbd{M-x
2277 enriched-mode}.
2278 @end itemize
2280   The command @code{format-decode-buffer} translates text in various
2281 formats into Emacs's internal format.  It asks you to specify the format
2282 to translate from; however, normally you can type just @key{RET}, which
2283 tells Emacs to guess the format.
2285 @findex format-find-file
2286   If you wish to look at a text/enriched file in its raw form, as a
2287 sequence of characters rather than as formatted text, use the @kbd{M-x
2288 find-file-literally} command.  This visits a file, like
2289 @code{find-file}, but does not do format conversion.  It also inhibits
2290 character code conversion (@pxref{Coding Systems}) and automatic
2291 uncompression (@pxref{Compressed Files}).  To disable format conversion
2292 but allow character code conversion and/or automatic uncompression if
2293 appropriate, use @code{format-find-file} with suitable arguments.
2295 @node Text Based Tables
2296 @section Editing Text-based Tables
2297 @cindex table mode
2298 @cindex text-based tables
2300   Table Mode provides an easy and intuitive way to create and edit WYSIWYG
2301 text-based tables.  Here is an example of such a table:
2303 @smallexample
2304 +-----------------+--------------------------------+-----------------+
2305 |     Command     |          Description           |   Key Binding   |
2306 +-----------------+--------------------------------+-----------------+
2307 |  forward-char   |Move point right N characters   |       C-f       |
2308 |                 |(left if N is negative).        |                 |
2309 |                 |                                |                 |
2310 |                 |On reaching end of buffer, stop |                 |
2311 |                 |and signal error.               |                 |
2312 +-----------------+--------------------------------+-----------------+
2313 |  backward-char  |Move point left N characters    |       C-b       |
2314 |                 |(right if N is negative).       |                 |
2315 |                 |                                |                 |
2316 |                 |On attempt to pass beginning or |                 |
2317 |                 |end of buffer, stop and signal  |                 |
2318 |                 |error.                          |                 |
2319 +-----------------+--------------------------------+-----------------+
2320 @end smallexample
2322   Table Mode allows the contents of the table such as this one to be
2323 easily manipulated by inserting or deleting characters inside a cell.
2324 A cell is effectively a localized rectangular edit region and edits to
2325 a cell do not affect the contents of the surrounding cells.  If the
2326 contents do not fit into a cell, then the cell is automatically
2327 expanded in the vertical and/or horizontal directions and the rest of
2328 the table is restructured and reformatted in accordance with the
2329 growth of the cell.
2331 @menu
2332 * Table Definition::          What is a text based table.
2333 * Table Creation::            How to create a table.
2334 * Table Recognition::         How to activate and deactivate tables.
2335 * Cell Commands::             Cell-oriented commands in a table.
2336 * Cell Justification::        Justifying cell contents.
2337 * Row Commands::              Manipulating rows of table cell.
2338 * Column Commands::           Manipulating columns of table cell.
2339 * Fixed Width Mode::          Fixing cell width.
2340 * Table Conversion::          Converting between plain text and tables.
2341 * Measuring Tables::          Analyzing table dimension.
2342 * Table Misc::                Table miscellany.
2343 @end menu
2345 @node Table Definition
2346 @subsection What is a Text-based Table?
2348   Look at the following examples of valid tables as a reference while
2349 you read this section:
2351 @example
2352               +--+----+---+     +-+     +--+-----+
2353               |  |    |   |     | |     |  |     |
2354               +--+----+---+     +-+     |  +--+--+
2355               |  |    |   |             |  |  |  |
2356               +--+----+---+             +--+--+  |
2357                                         |     |  |
2358                                         +-----+--+
2359 @end example
2361   A table consists of a rectangular frame and the contents inside the
2362 frame.  A table's cells must be at least one character wide and one
2363 character high with two adjacent cells sharing a boarder line.  A cell
2364 can be subdivided into multiple rectangular cells but cannot nest or
2365 overlap.
2367   Both the table frame and cell border lines must consist of one of
2368 three special characters.  The variables that hold these characters
2369 are described below:
2371 @table @code
2372 @vindex table-cell-vertical-char
2373 @item table-cell-vertical-char
2374 Holds the character used for vertical lines.  The default value is
2375 @samp{|}.
2377 @vindex table-cell-horizontal-char
2378 @item table-cell-horizontal-char
2379 Holds the character used for horizontal lines.  The default value is
2380 @samp{-}.
2382 @vindex table-cell-intersection-char
2383 @item table-cell-intersection-char
2384 Holds the character used at where horizontal line and vertical line
2385 meet.  The default value is @samp{+}.
2386 @end table
2388 @noindent
2389 Based on this definition, the following five tables are examples of invalid
2390 tables:
2392 @example
2393    +-----+    +-----+       +--+    +-++--+    ++
2394    |     |    |     |       |  |    | ||  |    ++
2395    | +-+ |    |     |       |  |    | ||  |
2396    | | | |    +--+  |    +--+--+    +-++--+
2397    | +-+ |    |  |  |    |  |  |    +-++--+
2398    |     |    |  |  |    |  |  |    | ||  |
2399    +-----+    +--+--+    +--+--+    +-++--+
2400      a           b          c          d        e
2401 @end example
2403 From left to right:
2405 @enumerate a
2406 @item
2407 Nested cells are not allowed.
2408 @item
2409 Overlapped cells or non-rectangular cells are not allowed.
2410 @item
2411 The border must be rectangular.
2412 @item
2413 Cells must have a minimum width/height of one character.
2414 @item
2415 Same as d.
2416 @end enumerate
2418 @node Table Creation
2419 @subsection How to Create a Table?
2420 @cindex create a text-based table
2421 @cindex table creation
2423 @findex table-insert
2424   The command to create a table is @code{table-insert}.  When called
2425 interactively, it asks for the number of columns, number of rows, cell
2426 width and cell height.  The number of columns is a number of cells
2427 within the table's width.  The number of rows is the number of cells
2428 within the table's height.  The cell width is a number of characters
2429 that fit within a cell width.  The cell height is a number of lines
2430 within cell height.  While the number of columns and number of rows
2431 must be an integer number, the cell width and the cell height can be
2432 either an integer number (when the value is constant across the table)
2433 or a series of integer numbers, separated by spaces or commas, where
2434 each number corresponds to each cell width within a row from left to
2435 right or each cell height within a column from top to bottom.
2437 @node Table Recognition
2438 @subsection Table Recognition
2439 @cindex table recognition
2441 @findex table-recognize
2442 @findex table-unrecognize
2443   Table Mode maintains special text properties in the buffer to allow
2444 editing in a convenient fashion.  When a buffer with tables is saved
2445 to its file, these text properties are lost, so when you visit this
2446 file again later, Emacs does not see a table, but just formatted text.
2447 To resurrect the table text properties, issue the @kbd{M-x
2448 table-recognize} command.  It scans the current buffer, recognizes
2449 valid table cells, and attaches appropriate text properties to allow
2450 for table editing.  The converse command, @code{table-unrecognize}, is
2451 used to remove the special text properties and revert the buffer back
2452 to plain text.
2454   An optional numeric prefix argument can precede the
2455 @code{table-recognize} command.  If the argument is negative, tables
2456 in the buffer become inactive.  This is equivalent to invoking
2457 @code{table-unrecognize}.
2459   Similar functions exist to enable or disable tables within a region,
2460 enable or disable individual tables, and enable/disable individual
2461 cells.  These commands are:
2463 @table @kbd
2464 @findex table-recognize-region
2465 @item M-x table-recognize-region
2466 Recognize tables within the current region and activate them.
2467 @findex table-unrecognize-region
2468 @item M-x table-unrecognize-region
2469 Deactivate tables within the current region.
2470 @findex table-recognize-table
2471 @item M-x table-recognize-table
2472 Recognize the table under point and activate it.
2473 @findex table-unrecognize-table
2474 @item M-x table-unrecognize-table
2475 Deactivate the table under point.
2476 @findex table-recognize-cell
2477 @item M-x table-recognize-cell
2478 Recognize the cell under point and activate it.
2479 @findex table-unrecognize-cell
2480 @item M-x table-unrecognize-cell
2481 Deactivate the cell under point.
2482 @end table
2484   For another way of converting text into tables, see @ref{Table
2485 Conversion}.
2487 @node Cell Commands
2488 @subsection Commands for Table Cells
2490 @findex table-forward-cell
2491 @findex table-backward-cell
2492   The commands @code{table-forward-cell} and
2493 @code{table-backward-cell} move point from the current cell to an
2494 adjacent cell forward and backward respectively.  The order of the
2495 cell is wrapped.  When point is positioned in the last cell of a
2496 table, typing @kbd{M-x table-forward-cell} moves point to the first
2497 cell in the table.  Likewise @kbd{M-x table-backward-cell} from the
2498 first cell in a table moves point to the last cell in the table.
2500 @findex table-span-cell
2501   The command @code{table-span-cell} spans the current cell into one
2502 of the four directions---right, left, above or below---and merges the
2503 current cell with the adjacent cell.  It does not allow directions to
2504 which spanning does not produce a legitimate cell.
2506 @findex table-split-cell
2507 @cindex text-based tables, split a cell
2508 @cindex split table cell
2509   The command @code{table-split-cell} splits the current cell
2510 vertically or horizontally.  This command is a wrapper to the
2511 direction specific commands @code{table-split-cell-vertically} and
2512 @code{table-split-cell-horizontally}.
2514 @findex table-split-cell-vertically
2515   The command @code{table-split-cell-vertically} splits the current
2516 cell vertically and creates a pair of cells above and below where
2517 point is located.  The content in the original cell is split as well.
2519 @findex table-split-cell-horizontally
2520   The command @code{table-split-cell-horizontally} splits the current
2521 cell horizontally and creates a pair of cells right and left of where
2522 point is located.  If the subject cell to split is not empty the user
2523 is asked how to handle the cell contents.  The three options are:
2524 @code{split}, @code{left}, or @code{right}.  @code{split} splits the
2525 contents at point literally while the @code{left} and @code{right}
2526 options move the entire contents into the left or right cell
2527 respectively.
2529 @cindex enlarge a table cell
2530 @cindex shrink a table cell
2531   The next four commands enlarge or shrink a cell.  These commands
2532 accept numeric arguments (@pxref{Arguments}) to specify how many
2533 columns or rows to enlarge or shrink a particular table.
2535 @table @kbd
2536 @findex table-heighten-cell
2537 @item M-x table-heighten-cell
2538 Enlarge the current cell vertically.
2539 @findex table-shorten-cell
2540 @item M-x table-shorten-cell
2541 Shrink the current cell vertically.
2542 @findex table-widen-cell
2543 @item M-x table-widen-cell
2544 Enlarge the current cell horizontally.
2545 @findex table-narrow-cell
2546 @item M-x table-narrow-cell
2547 Shrink the current cell horizontally.
2548 @end table
2550 @node Cell Justification
2551 @subsection Cell Justification
2552 @cindex cell text justification
2554   You can specify text justification for each cell.  The justification
2555 is remembered independently for each cell and the subsequent editing
2556 of cell contents is subject to the specified justification.
2558 @findex table-justify
2559   The command @code{table-justify} requests the user to specify what
2560 to justify: a cell,a column, or a row.  If you select cell
2561 justification, this command sets the justification only to the current
2562 cell.  Selecting column or row justification set the justification to
2563 all the cells within a column or row respectively.  The command then
2564 requests the user to enter which justification to apply: @code{left},
2565 @code{center}, @code{right}, @code{top}, @code{middle}, @code{bottom},
2566 or @code{none}.  The options @code{left}, @code{center}, and
2567 @code{right} specify horizontal justification while the options
2568 @code{top}, @code{middle}, @code{bottom}, and @code{none} specify
2569 vertical justification.  The vertical justification @code{none}
2570 effectively removes vertical justification while horizontal
2571 justification must be one of @code{left}, @code{center}, or
2572 @code{right}.  Horizontal justification and vertical justification are
2573 specified independently.
2575 @vindex table-detect-cell-alignment
2576   Justification information is stored in the buffer as a part of text
2577 property.  Therefore, this information is ephemeral and does not
2578 survive through the loss of the buffer (closing the buffer and
2579 revisiting the buffer erase any previous text properties).  To
2580 countermand for this, the command @code{table-recognize} and other
2581 recognition commands (@pxref{Table Recognition}) are equipped with a
2582 convenience feature (turned on by default).  During table recognition,
2583 the contents of a cell are examined to determine which justification
2584 was originally applied to the cell and then applies this justification
2585 to the the cell.  This is a speculative algorithm and is therefore not
2586 perfect, however, the justification is deduced correctly most of the
2587 time.  If you desire to disable this feature, customize the variable
2588 @code{table-detect-cell-alignment} to set it to @code{nil}.
2590 @node Row Commands
2591 @subsection Commands for Table Rows
2592 @cindex table row commands
2594 @cindex insert row in table
2595 @findex table-insert-row
2596   The command @code{table-insert-row} inserts a row of cells before
2597 the current row in a table.  The current row where point is located is
2598 pushed down after the newly inserted row.  A numeric prefix argument
2599 specifies the number of rows to insert.  Note that in order to insert
2600 rows @emph{after} the last row at the bottom of a table, you must
2601 place point below the table, i.e.@: outside the table, prior to
2602 invoking this command.
2604 @cindex delete row in table
2605 @findex table-delete-row
2606   The command @code{table-delete-row} deletes a row of cells at point.
2607 A numeric prefix argument specifies the number of rows to delete.
2609 @node Column Commands
2610 @subsection Commands for Table Columns
2611 @cindex table column commands
2613 @cindex insert column in table
2614 @findex table-insert-column
2615   The command @code{table-insert-column} inserts a column of cells to
2616 the left of the current row in a table.  The current column where
2617 point is located at is pushed right of the newly inserted column.  To
2618 insert a column to the right side of the right most column, place
2619 point to the right of the rightmost column, which is outside of the
2620 table, prior to invoking this command.  A numeric prefix argument
2621 specifies the number of columns to insert.
2623 @cindex delete column in table
2624   A command @code{table-delete-column} deletes a column of cells at
2625 point.  A numeric prefix argument specifies the number of columns to
2626 delete.
2628 @node Fixed Width Mode
2629 @subsection Fix Width of Cells
2630 @cindex fix width of table cells
2632 @findex table-fixed-width-mode
2633   The command @code{table-fixed-width-mode} toggles fixed width mode
2634 on and off.  When the fixed width mode is turned on, editing inside a
2635 cell never changes the cell width; when it is off, the cell width
2636 expands automatically in order to prevent a word from being folded
2637 into multiple lines.  By default, the fixed width mode is turned off.
2640 @node Table Conversion
2641 @subsection Conversion Between Plain Text and Tables
2642 @cindex text to table
2643 @cindex table to text
2645 @findex table-capture
2646   The command @code{table-capture} captures plain text in a region and
2647 turns it into a table.  Unlike @code{table-recognize} (@pxref{Table
2648 Recognition}), the original text does not have a table appearance but
2649 may hold a logical table structure.  For example, some elements
2650 separated by known patterns form a two dimensional structure which can
2651 be turned into a table.  Look at the numbers below.  The numbers are
2652 horizontally separated by a comma and vertically separated by a
2653 newline character.
2655 @example
2656 1, 2, 3, 4
2657 5, 6, 7, 8
2658 , 9, 10
2659 @end example
2661 @noindent
2662 When you invoke @kbd{M-x table-capture} on the above three-line
2663 region, the region can be turned into the next table:
2665 @example
2666 +-----+-----+-----+-----+
2667 |1    |2    |3    |4    |
2668 +-----+-----+-----+-----+
2669 |5    |6    |7    |8    |
2670 +-----+-----+-----+-----+
2671 |     |9    |10   |     |
2672 +-----+-----+-----+-----+
2673 @end example
2675 @noindent
2676 where @samp{,} is used for a column delimiter regexp, a newline is
2677 used for a row delimiter regexp, cells are left justified, and minimum
2678 cell width is 5.
2680 @findex table-release
2681   The command @code{table-release} does the opposite of
2682 @code{table-capture}.  It releases a table by removing the table frame
2683 and cell borders.  This leaves the table contents as plain text.  One
2684 of the useful applications of @code{table-capture} and
2685 @code{table-release} is to edit a text in layout.  Look at the
2686 following three paragraphs (the latter two are indented with header
2687 lines):
2689 @example
2690 @samp{table-capture} is a powerful command however mastering its power
2691 requires some practice.  Here is a list of items what it can do.
2693 Parse Cell Items      By using column delimiter regular
2694                       expression and raw delimiter regular
2695                       expression, it parses the specified text
2696                       area and extracts cell items from
2697                       non-table text and then forms a table out
2698                       of them.
2700 Capture Text Area     When no delimiters are specified it
2701                       creates a single cell table.  The text in
2702                       the specified region is placed in that
2703                       cell.
2704 @end example
2706 @noindent
2707 Applying @code{table-capture} to a region containing the above three
2708 paragraphs, with empty strings for column delimiter regexp and row
2709 delimiter regexp, creates a table with a single cell like the
2710 following one.
2712 @c The first line's right-hand frame in the following two examples
2713 @c sticks out to accommodate for the removal of @samp in the
2714 @c produced output!!
2715 @example
2716 +-----------------------------------------------------------------+
2717 |@samp{table-capture} is a powerful command however mastering its      |
2718 |power requires some practice.  Here is a list of items what it   |
2719 |can do.                                                          |
2720 |                                                                 |
2721 |Parse Cell Items      By using column delimiter regular          |
2722 |                      expression and raw delimiter regular       |
2723 |                      expression, it parses the specified text   |
2724 |                      area and extracts cell items from          |
2725 |                      non-table text and then forms a table out  |
2726 |                      of them.                                   |
2727 |                                                                 |
2728 |Capture Text Area     When no delimiters are specified it        |
2729 |                      creates a single cell table.  The text in  |
2730 |                      the specified region is placed in that     |
2731 |                      cell.                                      |
2732 +-----------------------------------------------------------------+
2733 @end example
2735 @noindent
2736 By splitting the cell appropriately we now have a table consisting of
2737 paragraphs occupying its own cell.  Each cell can now be edited
2738 independently without affecting the layout of other cells.
2740 @example
2741 +-----------------------------------------------------------------+
2742 |@samp{table-capture} is a powerful command however mastering its      |
2743 |power requires some practice.  Here is a list of items what it   |
2744 |can do.                                                          |
2745 +---------------------+-------------------------------------------+
2746 |Parse Cell Items     |By using column delimiter regular          |
2747 |                     |expression and raw delimiter regular       |
2748 |                     |expression, it parses the specified text   |
2749 |                     |area and extracts cell items from          |
2750 |                     |non-table text and then forms a table out  |
2751 |                     |of them.                                   |
2752 +---------------------+-------------------------------------------+
2753 |Capture Text Area    |When no delimiters are specified it        |
2754 |                     |creates a single cell table.  The text in  |
2755 |                     |the specified region is placed in that     |
2756 |                     |cell.                                      |
2757 +---------------------+-------------------------------------------+
2758 @end example
2760 @noindent
2761 By applying @code{table-release}, which does the opposite process, the
2762 contents become once again plain text.  @code{table-release} works as
2763 a companion command to @code{table-capture}.
2765 @node Measuring Tables
2766 @subsection Analyzing Table Dimensions
2767 @cindex table dimensions
2769 @findex table-query-dimension
2770   The command @code{table-query-dimension} analyzes a table structure
2771 and reports information regarding its dimensions.  In case of the
2772 above example table, the @code{table-query-dimension} command displays
2773 in echo area:
2775 @smallexample
2776 Cell: (21w, 6h), Table: (67w, 16h), Dim: (2c, 3r), Total Cells: 5
2777 @end smallexample
2779 @noindent
2780 This indicates that the current cell is 21 character wide and 6 lines
2781 high, the entire table is 67 characters wide and 16 lines high.  The
2782 table has 2 columns and 3 rows.  It has a total of 5 cells, since the
2783 first row has a spanned cell.
2785 @node Table Misc
2786 @subsection Table Miscellany
2788 @cindex insert string into table cells
2789 @findex table-insert-sequence
2790   The command @code{table-insert-sequence} inserts a string into each
2791 cell.  Each string is a part of a sequence i.e.@: a series of
2792 increasing integer numbers.
2794 @cindex table in language format
2795 @cindex table for HTML and LaTeX
2796 @findex table-generate-source
2797 The command @code{table-generate-source} generates a table formatted
2798 for a specific markup language.  It asks for a language (which must be
2799 one of @code{html}, @code{latex}, or @code{cals}), a destination
2800 buffer where to put the result, and the table caption (a string), and
2801 then inserts the generated table in the proper syntax into the
2802 destination buffer.  The default destination buffer is
2803 @code{table.@var{lang}}, where @var{lang} is the language you
2804 specified.
2806 @ignore
2807    arch-tag: 8db54ed8-2036-49ca-b0df-23811d03dc70
2808 @end ignore