aboutsummaryrefslogtreecommitdiffstats
path: root/etc
diff options
context:
space:
mode:
authorRichard M. Stallman1997-09-02 20:00:28 +0000
committerRichard M. Stallman1997-09-02 20:00:28 +0000
commit5418a92b00f8ffdee547c8a90b90d91ef1c1e994 (patch)
treeab18abf1482e5365938cc2f13b68811f2e737026 /etc
parent0351bce7c113e57bc817c8f99cb06e4f86a490cc (diff)
downloademacs-5418a92b00f8ffdee547c8a90b90d91ef1c1e994.tar.gz
emacs-5418a92b00f8ffdee547c8a90b90d91ef1c1e994.zip
Updated by Boris.
Diffstat (limited to 'etc')
-rw-r--r--etc/enriched.doc206
1 files changed, 96 insertions, 110 deletions
diff --git a/etc/enriched.doc b/etc/enriched.doc
index f13962fe379..0daec06606d 100644
--- a/etc/enriched.doc
+++ b/etc/enriched.doc
@@ -6,32 +6,30 @@ Text-Width: 70
6<x-bg-color><param>blue</param><x-color><param>white</param><bold>WYSIWYG rich text editing for GNU Emacs</bold></x-color></x-bg-color> 6<x-bg-color><param>blue</param><x-color><param>white</param><bold>WYSIWYG rich text editing for GNU Emacs</bold></x-color></x-bg-color>
7 7
8 8
9</center><bold><x-bg-color><param>blue</param><x-color><param>white</param>INTRODUCTION 9</center><bold><x-bg-color><param>blue</param><x-color><param>white</param>INTRODUCTION</x-color></x-bg-color></bold>
10 10
11</x-color></x-bg-color>
12 11
13</bold><indent>Emacs now has the ability to edit <italic>enriched text</italic>, which is text
14containing faces, colors, indentation, and other properties.
15This document is a quick introduction to some of the new features,
16and is also an example file in the <italic>text/enriched </italic>format.
17 12
13<indent>Emacs now has the ability to edit <italic>enriched text</italic>, which is text
14containing faces, colors, indentation, and other properties. This
15document is a quick introduction to some of the new features, and
16is also an example file in the <italic>text/enriched </italic>format.</indent>
18 17
19</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INSTALLATION and STARTUP
20 18
21</bold></x-color></x-bg-color> 19<x-bg-color><param>blue</param><x-color><param>white</param><bold>INSTALLATION and STARTUP</bold></x-color></x-bg-color>
20
22 21
23<indent>Most of the time, you need not do anything to get these features 22<indent>Most of the time, you need not do anything to get these features
24to work. If you visit a file that has been written out in 23to work. If you visit a file that has been written out in
25<italic>text/enriched</italic> format, it will automatically be decoded, Emacs will 24<italic>text/enriched</italic> format, it will automatically be decoded, Emacs will
26enter `enriched-mode' while visiting it, and whenever you save it 25enter `enriched-mode' while visiting it, and whenever you save it
27it will be saved in the same format it was read in. 26it will be saved in the same format it was read in.
28
29 27
30If you wish to create a new file, however, you will need to turn 28If you wish to create a new file, however, you will need to turn
31on enriched-mode yourself: 29on enriched-mode yourself:
32 30
33 31
34<fixed><indent>M-x enriched-mode RET</indent></fixed> 32<fixed><indent>M-x enriched-mode RET</indent></fixed>
35 33
36 34
37Or, if you get a <italic>text/enriched </italic>file that Emacs does not 35Or, if you get a <italic>text/enriched </italic>file that Emacs does not
@@ -39,225 +37,213 @@ automatically recognize and decode, you can tell Emacs to decode
39it (which also turns on enriched-mode automatically): 37it (which also turns on enriched-mode automatically):
40 38
41 39
42 <fixed>M-x format-decode-buffer RET text/enriched RET</fixed> 40<fixed><indent>M-x format-decode-buffer RET text/enriched RET</indent></fixed></indent>
43 41
44 42
45 43
46</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold><flushleft>WHAT IS ENCODED 44<x-bg-color><param>blue</param><x-color><param>white</param><bold>WHAT IS ENCODED</bold></x-color></x-bg-color>
47 45
48</flushleft></bold></x-color></x-bg-color><flushleft>
49 46
50</flushleft><indent>Here is the current list of text-properties that are saved; they 47<indent>Here is the current list of text-properties that are saved; they
51are discussed in more detail below. 48are discussed in more detail below. Most of these can be added or
52Most of these can be added or changed with the "Text Properties" 49changed with the "Text Properties" menu, available under the
53menu, available under the "Edit" item in the menu-bar, or on 50"Edit" item in the menu-bar, or on C-mouse-2 (Control + the middle
54C-mouse-2 (Control + the middle mouse button). 51mouse button).
55 52
56<bold>Faces:</bold> default, <bold>bold</bold>, <italic>italic</italic>, <underline>underline</underline>, <fixed>fixed</fixed>, etc. 53<bold>Faces:</bold> <indent>default, <bold>bold</bold>, <italic>italic</italic>, <underline>underline</underline>, etc.</indent>
57 54
58<bold>Colors:</bold> <x-color><param>red</param><x-bg-color><param>DarkSlateGray</param>any</x-bg-color></x-color><x-bg-color><param>DarkSlateGray</param><x-color><param>orange</param>thing</x-color> <x-color><param>yellow</param>your</x-color><x-color><param>green</param> screen</x-color><x-color><param>blue</param> </x-color><x-color><param>light blue</param>can</x-color><x-color><param>violet</param> display...</x-color></x-bg-color> 55<bold>Colors:</bold> <x-color><param>red</param><x-bg-color><param>DarkSlateGray</param><indent>any</indent></x-bg-color></x-color><x-bg-color><param>DarkSlateGray</param><indent><x-color><param>orange</param>thing</x-color> <x-color><param>yellow</param>your</x-color><x-color><param>green</param> screen</x-color><x-color><param>blue</param> </x-color><x-color><param>light blue</param>can</x-color><x-color><param>violet</param> display...</x-color></indent></x-bg-color>
59 56
60<bold>Newlines:</bold> <indent>Which ones are real ("hard") newlines, and which can be 57<bold>Newlines:</bold> <indent>Which ones are real ("hard") newlines, and which can be
61changed to fit lines into the ma</indent>rgins. 58changed to fit lines into the margins.</indent>
62 59
63<bold>Margins:</bold> can be indented on the left or right. 60<bold>Margins:</bold> <indent>can be indented on the left or right.</indent>
64 61
65<bold>Justification </bold><indent>(whether lines should be flush with the left margin, 62<bold>Justification</bold> <indent>(whether lines should be flush with the left margin,
66the right margin, fully justified, centered, or left alo</indent>ne). 63the right margin, fully justified, centered, or left alone).</indent>
67 64
68<bold>Excerpts: "</bold><excerpt>For quoted material."</excerpt> 65<bold>Excerpts:</bold><indent> <excerpt>"For quoted material."</excerpt></indent>
69 66
70<bold>Read-only</bold> regions. 67<bold>Read-only</bold> regions.
71 68
69</indent>
72 70
73</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>FACES and COLORS 71<x-bg-color><param>blue</param><x-color><param>white</param><bold>FACES and COLORS</bold></x-color></x-bg-color>
74 72
75</bold></x-color></x-bg-color><bold>
76 73
77</bold><indent>You can add faces either with the menu or with <fixed>M-g.</fixed> The face is 74<indent>You can add faces either with the menu or with <fixed>M-g.</fixed> The face is
78applied to the current region. If you are using 75applied to the current region. If you are using
79`transient-mark-mode' and the region is not active, then the face 76`transient-mark-mode' and the region is not active, then the face
80applies to whatever you type next. Any face can have colors, but 77applies to whatever you type next. Any face can have colors, but
81faces have no other attributes are put on the color submenus of 78faces have no other attributes are put on the color submenus of
82the "Text Properties" menu. 79the "Text Properties" menu.</indent>
83 80
84 81
85</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>NEWLINES and PARAGRAPHS 82<x-bg-color><param>blue</param><x-color><param>white</param><bold>NEWLINES and PARAGRAPHS</bold></x-color></x-bg-color>
86 83
87</bold></x-color></x-bg-color><bold>
88 84
89</bold><indent><italic>Text/enriched</italic> format distinguishes between <underline>hard</underline> and <underline>soft</underline> newlines. 85<italic><indent>Text/enriched</indent></italic><indent> format distinguishes between <underline>hard</underline> and <underline>soft</underline> newlines.
90Hard newlines are used to separate paragraphs, or items in a list, 86Hard newlines are used to separate paragraphs, or items in a list,
91or anywhere that must be a line break no matter what the margins 87or anywhere that must be a line break no matter what the margins
92are. Soft newlines are the ones inserted in order to fit text 88are. Soft newlines are the ones inserted in order to fit text
93between the margins. The fill and auto-fill functions insert soft 89between the margins. The fill and auto-fill functions insert soft
94newlines as necessary, but hard newlines are only inserted by 90newlines as necessary, but hard newlines are only inserted by
95direct request, such as using the return key or the <fixed>C-o 91direct request, such as using the return key or the <fixed>C-o
96(open-line)</fixed> function. 92(open-line)</fixed> function.</indent>
93
97 94
95<x-bg-color><param>blue</param><x-color><param>white</param><bold>INDENTATION</bold></x-color></x-bg-color>
98 96
99</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INDENTATION
100 97
101</bold></x-color></x-bg-color><bold> 98<indent>The fill functions also understand margins, which can be set for
99any region of a document. In addition to the menu items, which
100increase or decrease the margins, there are two commands for
101setting the margins absolutely: <fixed>C-c C-l (set-left-margin)</fixed> and <fixed>C-c
102C-r (set-right-margin)</fixed>.
102 103
103</bold><indent><indentright>The fill functions also understand margins, which can be set
104for any region of a document. In addition to the menu items,
105which increase or decrease the margins, there are two commands
106for setting the margins absolutely: <fixed>C-c l (set-left-margin)</fixed>
107and <fixed>C-c r (set-right-margin)</fixed>.
108<flushleft>
109 104
110</flushleft></indentright><flushleft>You <indent>can change indentation at any point in a</indent></flushleft></indent> <indent><indent><flushleft>paragraph, which 105You <indent>can change indentation at any point in a paragraph, which
111makes it possible to do interesting things like</flushleft> 106makes it possible to do interesting things like
112<flushleft>hanging-indents: this paragraph was indented by selecting the 107hanging-indents: this paragraph was indented by selecting the
113region from the second word to the end of the paragraph, and 108region from the second word to the end of the paragraph, and
114indenting only that part.<indent> 109indenting only that part.</indent></indent>
115 110
116</indent></flushleft></indent></indent><flushleft>
117 111
118<x-bg-color><param>blue</param><x-color><param>white</param><bold>JUSTIFICATION<indent> 112<x-bg-color><param>blue</param><x-color><param>white</param><bold>JUSTIFICATION</bold></x-color></x-bg-color>
119 113
120</indent></bold></x-color></x-bg-color><bold><indent>
121 114
122</indent></bold></flushleft><indent><nofill>Several styles of justification are possible, the simplest being <italic>unfilled. 115
116<indent><nofill>Several styles of justification are possible, the simplest being <italic>unfilled.
123</italic>This means that your lines will be left as you write them. 117</italic>This means that your lines will be left as you write them.
124This paragraph is unfilled. 118This paragraph is unfilled.</nofill>
119
125 120
126The most common (for English) style is <italic>FlushLeft. </italic>This means 121<flushleft>The most common (for English) style is <italic>FlushLeft. </italic>This means
127lines are aligned at the left margin but left uneven at the 122lines are aligned at the left margin but left uneven at the right.</flushleft>
128right.
129 123
130 124
131 </nofill><italic><flushright>FlushRight</flushright></italic><flushright> makes each line flush with the right margin instead. 125<flushright> <italic>FlushRight</italic> makes each line flush with the right margin instead.
126 This paragraph is FlushRight.</flushright>
132 127
133 128
134 129
135</flushright><italic><flushboth>FlushBoth </flushboth></italic><flushboth>regions, which are sometimes called "fully justified" 130<flushboth><italic>FlushBoth </italic>regions, which are sometimes called "fully justified"
136are aligned evenly on both edges, so that the text on the page has 131are aligned evenly on both edges, so that the text on the page has
137a smooth appearance as in a book or newspaper article. 132a smooth appearance as in a book or newspaper article.
138Unfortunately this does not look as nice with a fixed-width font 133Unfortunately this does not look as nice with a fixed-width font
139as it does in a proportionally-spaced printed document; the extra 134as it does in a proportionally-spaced printed document; the extra
140spaces that are needed on the screen can make it hard to read. <indentright><indentright><indentright><indentright> 135spaces that are needed on the screen can make it hard to read. </flushboth>
141 136
137<center>
142 138
143 </indentright></indentright></indentright></indentright></flushboth><bold><center>Center 139 <bold>Center</bold>
144 140
145 </center></bold><center>Finally, there is <italic>center </italic>justification. 141 Finally, there is <italic>center </italic>justification. The normal
146 The normal center-paragraph key, M-S, can be used to turn on 142 center-paragraph key, M-S, can be used to turn on center
147 center justification in enriched-mode. 143 justification in enriched-mode.
148 144
149 M-j or the "Text Properties" menu also can be used to change 145 M-j or the "Text Properties" menu also can be used to change
150 justification. 146 justification.
151 147
152 148
153 149
154</center><flushboth>Note that justification can only change at hard newlines, because 150</center><flushboth>Note that justification can only change at hard newlines, because
155that is the unit over which filling gets done. 151that is the unit over which filling gets done. </flushboth></indent>
156 152
157 153
158</flushboth></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>EXCERPTS 154<x-bg-color><param>blue</param><x-color><param>white</param><bold>EXCERPTS</bold></x-color></x-bg-color>
159 155
160</bold></x-color></x-bg-color>
161 156
162<excerpt><indent>This is an example of an excerpt. You can use them for quoted 157<excerpt><indent>This is an example of an excerpt. You can use them for quoted
163parts of other people's email messages and the like. It is just a 158parts of other people's email messages and the like. It is just a
164face, which is the same as the `italic' face by default. 159face, which is the same as the `italic' face by default.</indent></excerpt>
165 </indent></excerpt>
166 160
167<x-bg-color><param>blue</param><x-color><param>white</param><bold>THE FILE FORMAT<indent>
168 161
169</indent></bold></x-color></x-bg-color><indent> 162<x-bg-color><param>blue</param><x-color><param>white</param><bold>THE FILE FORMAT</bold></x-color></x-bg-color>
170 163
171Enriched-mode documents are saved in an extended version of a 164
165<indent>Enriched-mode documents are saved in an extended version of a
172format called <italic>text/enriched</italic>, which is defined as part of the MIME 166format called <italic>text/enriched</italic>, which is defined as part of the MIME
173standard. This means that your documents are transportable (even 167standard. This means that your documents are transportable (even
174through email) to many</indent> <indent>other systems. In the future other file 168through email) to many other systems. In the future other file
175formats may be supported as well. 169formats may be supported as well.
176 170
177 171
178Since Emacs adds some non-standard features to the format (colors 172Since Emacs adds some non-standard features to the format (colors
179
180and read-only regions), not all systems will be able to recreate 173and read-only regions), not all systems will be able to recreate
181all of the features of your document, but they will get as close 174all of the features of your document, but they will get as close
182as possible. 175as possible.
183 176
184 177
185The MIME standard is defined in internet RFC 1521; text/enriched 178The MIME standard is defined in </indent>Internet<indent> RFC 1521; text/enriched
186is defined in RFC 1563. Details on obtaining these documents via 179is defined in RFC 1563. Details on obtaining these documents via
187FTP or email may be obtained by sending an email message to 180FTP or email may be obtained by sending an email message to
188<fixed>rfc-info@isi.edu</fixed> with the message body: 181<fixed>rfc-info@isi.edu</fixed> with the message body:
189 182
190<fixed><indent>help: ways_to_get_rfcs 183
184<fixed><indent>help: ways_to_get_rfcs</indent></fixed>
191 185
192 186
193</indent></fixed>See also the newsgroup comp.mail.mime. 187<indent>See also the newsgroup <fixed>comp.mail.mime</fixed>.</indent></indent>
194 188
195 189
196</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>CUSTOMIZATION 190<x-bg-color><param>blue</param><x-color><param>white</param><bold>CUSTOMIZATION</bold></x-color></x-bg-color><bold>
197 191
198</bold></x-color></x-bg-color><bold>
199 192
200</bold><indent>-<indent> The <fixed>fixed </fixed>and <excerpt>excerpt </excerpt>faces should be set to your liking.</indent> 193</bold><indent>-<indent> The <fixed>fixed </fixed>and <excerpt>excerpt </excerpt>faces should be set to your liking.</indent>
201 194
202- <indent>User-preference variables: <fixed>default-justification, enriched-verbose. 195-<indent> User-preference variables: <fixed>default-justification,
203</fixed></indent>- <indent>You can add annotations for your own text properties by making 196enriched-verbose.
197
198</fixed></indent>-<indent> You can add annotations for your own text properties by making
204additions to <fixed>enriched-annotation-alist</fixed>. Note that the 199additions to <fixed>enriched-annotation-alist</fixed>. Note that the
205standard requires you to name your annotation starting<italic> "x-" 200standard requires you to name your annotation starting<italic> "x-"
206</italic>(as in <italic>"x-read-only"</italic>). Please send me any such additions that 201</italic>(as in <italic>"x-read-only"</italic>). Please send me any such additions that
207you think might be of general interest so that I can include 202you think might be of general interest so that I can include
208them in the distribution. 203them in the distribution.</indent>
204
205</indent>
209 206
207<x-bg-color><param>blue</param><x-color><param>white</param><bold>TO-DO LIST</bold></x-color></x-bg-color>
210 208
211</indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>TO-DO LIST
212 209
213</bold></x-color></x-bg-color><bold> 210<italic><indent>[Feel free to work on these and send me the results!]</indent></italic><indent>
214 211
215</bold><indent><italic>[Feel free to work on these and send me the results!]</italic> 212+ Conform to updated text/enriched spec in RFC 1896.
216 213
217- Be smarter about fixing malformed files. 214+ Be smarter about fixing malformed files.
218 215
219- Make the indentation work more seamlessly and robustly: 216+ Make the indentation work more seamlessly and robustly:
220 217
221<indent>+ Create<indent> an aggressive auto-fill function that will keep the 218+ Create<indent> an aggressive auto-fill function that will keep the
222paragraph properly filled all the time, without slowing 219paragraph properly filled all the time, without slowing down
223down editing too much.</indent> 220editing too much.</indent>
224 221
225+ Refill after yank. 222+ Refill after yank.
226 223
227+ <indent>Make deleting a newline also delete the indentation 224+<indent> Make deleting a newline also delete the indentation following
228following it.</indent> 225it.</indent>
229 226
230+ Never let point enter indentation?? 227+ Never let point enter indentation??
231 228
232</indent>- Notice and re-fill when window changes widths (optionally). 229+ Notice and re-fill when window changes widths (optionally).
233 230
234- Deal with the `category' text-property in a smart way. 231+ Deal with the `category' text-property in a smart way.
235 232
236- Interface w/ GNUS, VM, RMAIL. Maybe Info too? 233+ Interface w/ GNUS, VM, RMAIL. Maybe Info too?
237 234
238-<indent> Support more formats: RTF, HTML... 235+ Support more formats: RTF, HTML...
239 236
237</indent>
240 238
241</indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>Final Notes: 239<x-bg-color><param>blue</param><x-color><param>white</param><bold>Final Notes:</bold></x-color></x-bg-color>
242 240
243</bold></x-color></x-bg-color><bold>
244 241
245</bold><indent>This code and documentation is under development. 242<indent>This code and documentation is under development. Comments and
246 </indent>Comments and bug reports are welcome. 243bug reports are welcome.</indent>
247 244
248 245
249<bold><x-color><param>white</param><x-bg-color><param>blue</param>Boris Goldowsky</x-bg-color></x-color><x-color><param>light blue</param> </x-color></bold><x-color><param>light blue</param><fixed><<boris@gnu.ai.mit.edu></fixed></x-color><x-color><param>blue</param> 246<bold><x-color><param>white</param><x-bg-color><param>blue</param>Boris Goldowsky</x-bg-color></x-color><x-color><param>light blue</param> </x-color></bold><x-color><param>light blue</param><fixed><<boris@gnu.ai.mit.edu></fixed></x-color><x-color><param>blue</param>
250 247
251</x-color><x-bg-color><param>blue</param><x-color><param>white</param> April 1995 </x-color></x-bg-color><x-color><param>blue</param> 248</x-color><x-bg-color><param>blue</param><x-color><param>white</param>April 1995; updated August 1997</x-color></x-bg-color>
252
253
254
255
256
257
258
259
260
261
262 249
263</x-color>