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