annotate man/text.texi @ 69401:259ab035a718

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