annotate man/text.texi @ 79694:9ba64003e7cd

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