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