diff options
| author | Boris Goldowsky | 1995-04-07 19:59:47 +0000 |
|---|---|---|
| committer | Boris Goldowsky | 1995-04-07 19:59:47 +0000 |
| commit | f604450a137b0a494e41533b03ab1b2a75079ef1 (patch) | |
| tree | d081efcabe9fffa4f8f179669acd51ecd0488d3b | |
| parent | 01d5e8928aadf0f5e03d40a6031625d704683ce2 (diff) | |
| download | emacs-f604450a137b0a494e41533b03ab1b2a75079ef1.tar.gz emacs-f604450a137b0a494e41533b03ab1b2a75079ef1.zip | |
Rewritten and simplified.
| -rw-r--r-- | etc/enriched.doc | 375 |
1 files changed, 152 insertions, 223 deletions
diff --git a/etc/enriched.doc b/etc/enriched.doc index 93a59e525ba..0f001fe30cb 100644 --- a/etc/enriched.doc +++ b/etc/enriched.doc | |||
| @@ -1,325 +1,254 @@ | |||
| 1 | Content-type: text/enriched | 1 | Content-Type: text/enriched |
| 2 | Text-width: 86 | 2 | Text-Width: 70 |
| 3 | 3 | ||
| 4 | <center><x-bg-color><param>blue</param><x-color><param>white</param><bold><fixed>enriched.el:</fixed></bold></x-color></x-bg-color> | ||
| 4 | 5 | ||
| 5 | <<center><<bold><<x-bg-color><<param>gray<</param><<x-color><<param>blue<</param>Enriched: | 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 | 7 | ||
| 7 | A WYSIWYG enriched-text editing environment for GNU Emacs | ||
| 8 | 8 | ||
| 9 | </center><bold><x-bg-color><param>blue</param><x-color><param>white</param>INTRODUCTION | ||
| 9 | 10 | ||
| 10 | <</x-color><</x-bg-color><</bold><</center><<bold>INTRODUCTION | 11 | </x-color></x-bg-color> |
| 11 | 12 | ||
| 13 | </bold><indent>Emacs now has the ability to edit <italic>enriched text</italic>, which is text | ||
| 14 | containing faces, colors, indentation, and other properties. | ||
| 15 | This document is a quick introduction to some of the new features, | ||
| 16 | and is also an example file in the <italic>text/enriched </italic>format. | ||
| 12 | 17 | ||
| 13 | <</bold><<indent>This package, along with the <<bold>facemenu<</bold> package, is the beginning of a WYSIWYG | ||
| 14 | ("what you see is what you get") Emacs mode for editing <<italic>enriched text: <</italic>text with | ||
| 15 | different faces, colors, etc. Facemenu allows you to add faces (such as | ||
| 16 | <<bold>boldface<</bold>, <<italic>italics<</italic>, and <<underline>underlining<</underline>) your documents, while <<bold>enriched<</bold> allows you to | ||
| 17 | save the documents with those "text properties" included. The format in which | ||
| 18 | they are saved is called <<italic>text/enriched<</italic>, and is defined as part of the MIME | ||
| 19 | standard, so that your documents are transportable (even through email) to many | ||
| 20 | other systems. | ||
| 21 | 18 | ||
| 19 | </indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INSTALLATION and STARTUP | ||
| 22 | 20 | ||
| 23 | Not all systems will be able to recreate all of the features of your document, | 21 | </bold></x-color></x-bg-color> |
| 24 | but they will get as close as possible. For systems that do not understand it at | ||
| 25 | all, the text of the document should still be legible; the reader can simply | ||
| 26 | ignore the annotations specifying face changes and the like. | ||
| 27 | 22 | ||
| 23 | <indent>Most of the time, you need not do anything to get these features | ||
| 24 | to 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 | ||
| 26 | enter `enriched-mode' while visiting it, and whenever you save it | ||
| 27 | it will be saved in the same format it was read in. | ||
| 28 | |||
| 28 | 29 | ||
| 29 | <</indent><<bold>INSTALLATION and STARTUP <</bold> | 30 | If you wish to create a new file, however, you will need to turn |
| 31 | on enriched-mode yourself: | ||
| 30 | 32 | ||
| 31 | 33 | ||
| 32 | <<indent>The <<fixed>enriched.el<</fixed> file should be installed somewhere that emacs will find it (ie, | 34 | <fixed><indent>M-x enriched-mode RET</indent></fixed> |
| 33 | one of the directories on emacs's <<fixed>load-path <</fixed>variable), and byte-compiled for | ||
| 34 | speed. | ||
| 35 | 35 | ||
| 36 | 36 | ||
| 37 | The documentation below assumes that you have my <<fixed>facemenu.el<</fixed> (which is included | 37 | Or, if you get a <italic>text/enriched </italic>file that Emacs does not |
| 38 | in recent versions of emacs). You may also find it useful to have Jim Thompson's | 38 | automatically recognize and decode, you can tell Emacs to decode |
| 39 | <<fixed>ps-print.el<</fixed>, which will allow you to print out buffers including their faces | 39 | it (which also turns on enriched-mode automatically): |
| 40 | (unfortunately it is not currently able to deal with merged faces; hopefully it | ||
| 41 | will be revised soon.) These two files should also be installed into your lisp | ||
| 42 | directory and byte-compiled. | ||
| 43 | 40 | ||
| 44 | 41 | ||
| 45 | Put the following code into your .emacs file to automatically load enriched when | 42 | <fixed>M-x format-decode-buffer RET text/enriched RET</fixed> |
| 46 | needed: | ||
| 47 | 43 | ||
| 44 | |||
| 48 | 45 | ||
| 49 | <<indent><<fixed>(autoload 'enriched-mode "enriched" nil t)<</fixed><</indent> | 46 | </indent><x-bg-color><param>blue</param><x-color><param>white</param><bold><flushleft>WHAT IS ENCODED |
| 50 | 47 | ||
| 48 | </flushleft></bold></x-color></x-bg-color><flushleft> | ||
| 51 | 49 | ||
| 52 | <<bold>Enriched <</bold>puts an identifying header into files it writes, which allows it to | 50 | </flushleft><indent>Here is the current list of text-properties that are saved; they |
| 53 | recognize any emacs-generated <<italic>text/enriched<</italic> file and put itself into the proper | 51 | are discussed in more detail below. |
| 54 | mode. If you get a file from some other source, however, such as through the | 52 | Most of these can be added or changed with the "Text Properties" |
| 55 | mail, you may have to enter enriched-mode manually: | 53 | menu, available under the "Edit" item in the menu-bar, or on |
| 54 | C-mouse-2 (Control + the middle mouse button). | ||
| 56 | 55 | ||
| 56 | <bold>Faces:</bold> default, <bold>bold</bold>, <italic>italic</italic>, <underline>underline</underline>, <fixed>fixed</fixed>, etc. | ||
| 57 | 57 | ||
| 58 | <<indent><<fixed>M-x enriched-mode<</fixed><</indent> | 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> |
| 59 | 59 | ||
| 60 | <bold>Newlines:</bold> <indent>Which ones are real ("hard") newlines, and which can be | ||
| 61 | changed to fit lines into the ma</indent>rgins. | ||
| 60 | 62 | ||
| 61 | You may be asked a couple of questions at this point: | 63 | <bold>Margins:</bold> can be indented on the left or right. |
| 62 | 64 | ||
| 65 | <bold>Justification </bold><indent>(whether lines should be flush with the left margin, | ||
| 66 | the right margin, fully justified, centered, or left alo</indent>ne). | ||
| 63 | 67 | ||
| 64 | <<italic>Does the buffer need to be translated now?<</italic> If the buffer contains <<italic>text/enriched | 68 | <bold>Excerpts: "</bold><excerpt>For quoted material."</excerpt> |
| 65 | <</italic>data which needs to be translated into a readable document with fonts and such, | ||
| 66 | then answer "yes". If you are putting a new document into text/enriched format | ||
| 67 | for the first time, then say "no". | ||
| 68 | 69 | ||
| 70 | <bold>Read-only</bold> regions. | ||
| 69 | 71 | ||
| 70 | <<italic>Reformat for current display width?<</italic> If emacs knows that the document was created | ||
| 71 | with the same display width that is currently in effect, it will trust the line | ||
| 72 | breaks that are in the file, which saves some time. If it was saved at a | ||
| 73 | different width, or emacs doesn't know what width it was saved at, then it may | ||
| 74 | ask whether it should reformat. Actually it does not ask by default; it just | ||
| 75 | goes ahead and fills. But if you want it to ask, you can set the variable | ||
| 76 | <<fixed>enriched-fill-after-visiting<</fixed> to <<fixed>'ask<</fixed>. | ||
| 77 | 72 | ||
| 73 | </indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>FACES and COLORS | ||
| 78 | 74 | ||
| 79 | In the future, other modes such as mail and news may recognize messages that are | 75 | </bold></x-color></x-bg-color><bold> |
| 80 | enriched text, and automatically call on <<bold>enriched<</bold> to display them for you. | ||
| 81 | 76 | ||
| 77 | </bold><indent>You can add faces either with the menu or with <fixed>M-g.</fixed> The face is | ||
| 78 | applied to the current region. If you are using | ||
| 79 | `transient-mark-mode' and the region is not active, then the face | ||
| 80 | applies to whatever you type next. Any face can have colors, but | ||
| 81 | faces have no other attributes are put on the color submenus of | ||
| 82 | the "Text Properties" menu. | ||
| 82 | 83 | ||
| 83 | <</indent><<bold>WHAT IS ENCODED<</bold> | ||
| 84 | 84 | ||
| 85 | </indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>NEWLINES and PARAGRAPHS | ||
| 85 | 86 | ||
| 86 | <<indent>Aside from the text itself, various properties are saved. More will eventually | 87 | </bold></x-color></x-bg-color><bold> |
| 87 | be added, so that you will be able to save and read just about anything that can | ||
| 88 | be displayed in an emacs frame. Following is the list of properties that are | ||
| 89 | currently understood; each is covered in more detail below. | ||
| 90 | 88 | ||
| 89 | </bold><indent><italic>Text/enriched</italic> format distinguishes between <underline>hard</underline> and <underline>soft</underline> newlines. | ||
| 90 | Hard newlines are used to separate paragraphs, or items in a list, | ||
| 91 | or anywhere that must be a line break no matter what the margins | ||
| 92 | are. Soft newlines are the ones inserted in order to fit text | ||
| 93 | between the margins. The fill and auto-fill functions insert soft | ||
| 94 | newlines as necessary, but hard newlines are only inserted by | ||
| 95 | direct request, such as using the return key or the <fixed>C-o | ||
| 96 | (open-line)</fixed> function. | ||
| 91 | 97 | ||
| 92 | <<bold>Faces:<</bold> default, <<bold>bold<</bold>, <<italic>italic<</italic>, <<underline>underline<</underline>, <<fixed>fixed<</fixed>, etc. | ||
| 93 | 98 | ||
| 94 | <<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> | 99 | </indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INDENTATION |
| 95 | 100 | ||
| 96 | <<bold>Newlines:<</bold> <<indent>Which ones are real ("hard") newlines, and which can be changed to fit | 101 | </bold></x-color></x-bg-color><bold> |
| 97 | lines into the ma<</indent>rgins. | ||
| 98 | 102 | ||
| 99 | <<bold>Margins:<</bold> can be indented on the left or right. | 103 | </bold><indent><indentright>The fill functions also understand margins, which can be set |
| 104 | for any region of a document. In addition to the menu items, | ||
| 105 | which increase or decrease the margins, there are two commands | ||
| 106 | for setting the margins absolutely: <fixed>C-c l (set-left-margin)</fixed> | ||
| 107 | and <fixed>C-c r (set-right-margin)</fixed>. | ||
| 108 | <flushleft> | ||
| 100 | 109 | ||
| 101 | <<bold>Justification <</bold><<indent>(whether lines should be flush with the left margin, the right | 110 | </flushleft></indentright><flushleft>You <indent>can change indentation at any point in a</indent></flushleft></indent> <indent><indent><flushleft>paragraph, which |
| 102 | margin, fully justified, centered, or left alo<</indent>ne). | 111 | makes it possible to do interesting things like</flushleft> |
| 112 | <flushleft>hanging-indents: this paragraph was indented by selecting the | ||
| 113 | region from the second word to the end of the paragraph, and | ||
| 114 | indenting only that part.<indent> | ||
| 103 | 115 | ||
| 104 | <<bold>Excerpts: "<</bold><<excerpt>For quoted material." <</excerpt> | 116 | </indent></flushleft></indent></indent><flushleft> |
| 105 | 117 | ||
| 106 | <<bold>Read-only<</bold> regions. | 118 | <x-bg-color><param>blue</param><x-color><param>white</param><bold>JUSTIFICATION<indent> |
| 107 | 119 | ||
| 120 | </indent></bold></x-color></x-bg-color><bold><indent> | ||
| 108 | 121 | ||
| 109 | <</indent><<bold>FACES | 122 | </indent></bold></flushleft><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. | ||
| 124 | This paragraph is unfilled. | ||
| 110 | 125 | ||
| 111 | 126 | The most common (for English) style is <italic>FlushLeft. </italic>This means | |
| 112 | <</bold><<indent>The easiest way to add a face to a region is to use the <<bold>facemenu <</bold>package. This | ||
| 113 | defines a menu obtained by clicking the right mouse button while holding the | ||
| 114 | control key. For example, to make a word boldface, you could select the word by | ||
| 115 | double-clicking on it, then hold C-mouse-3 and select <<italic>Bold<</italic> from the <<italic>Face | ||
| 116 | <</italic><</indent>sub-menu<<indent>. Selecting a face from the menu when the region is not active will apply | ||
| 117 | that face to whatever you type next. | ||
| 118 | |||
| 119 | |||
| 120 | <</indent><<bold>NEWLINES and PARAGRAPHS | ||
| 121 | |||
| 122 | |||
| 123 | <</bold><<indent><<italic>Text/enriched<</italic> format distinguishes between <<underline>hard<</underline> newlines and <<underline>soft <</underline>newlines. Hard | ||
| 124 | newlines are used to separate paragraphs, or items in a list, or anywhere that | ||
| 125 | must be a line break no matter what the margins are. Soft newlines are the ones | ||
| 126 | inserted in order to fit text between the margins. Auto-fill-mode and | ||
| 127 | enriched-mode's fill functions insert soft newlines as necessary, but hard | ||
| 128 | newlines are only inserted by direct request, such as using the return key or the | ||
| 129 | <<fixed>C-o (open-line)<</fixed> function. | ||
| 130 | |||
| 131 | |||
| 132 | <</indent><<bold>INDENTATION | ||
| 133 | |||
| 134 | |||
| 135 | <</bold><<indent>Indentation of regions of the document can be flexibly controlled. The face menu | ||
| 136 | contains an <<italic>Indent<</italic> item, which indents the region by the width of 4 characters | ||
| 137 | and an <<italic>UnIndent <</italic>item which removes 4 character-widths of indentation. All of the | ||
| 138 | text paragraphs in this file are singly indented relative to the headings, for | ||
| 139 | example. In addition, you can indent and unindent the <<italic>right <</italic>margin though use of | ||
| 140 | the <<italic>IndentRight<</italic> and <<italic>UnindentRight <</italic>menu items. The indentation commands can be | ||
| 141 | used repeatedly to get further levels of indentation. There are also shortcut | ||
| 142 | commands to set the left and right margins directly. | ||
| 143 | |||
| 144 | The basic editing commands in enriched-mode have been modified as necessary to | ||
| 145 | maintain proper indentation, but if it gets messed up, you can use <<fixed>C-q<</fixed> to | ||
| 146 | reformat the current paragraph. This may be necessary, for example, after | ||
| 147 | yanking or pasting text into the buffer. Eventually all commands should respect | ||
| 148 | indentation. <<flushleft><<indentright><<indentright><<indentright><<indentright> | ||
| 149 | |||
| 150 | |||
| 151 | <</indentright>Not <<indent>only whole paragraphs can be indented, but in fact any region. | ||
| 152 | This makes it possible to have hanging-indents on paragraphs like | ||
| 153 | this one: it was accomplished by selecting the region starting | ||
| 154 | after the first word of the paragraph and going to the end of the | ||
| 155 | paragraph, and indenting that. <</indent><</indentright><</indentright><</indentright><<indent>Also notice that this paragraph had been | ||
| 156 | indented on the right until the beginning of this sentence, when it resumed | ||
| 157 | normal w<</indent>i<</flushleft><</indent><<flushleft>dth. | ||
| 158 | |||
| 159 | |||
| 160 | <<bold>JUSTIFICATION<<indent> | ||
| 161 | |||
| 162 | |||
| 163 | <</indent><</bold><</flushleft><<indent><<nofill>Several styles of justification are possible, the simplest being <<italic>unfilled. | ||
| 164 | <</italic>This means that your lines will be left as you write them. | ||
| 165 | This paragraph, for instance, is unfilled. | ||
| 166 | It was written with one sentence on a line. | ||
| 167 | <<bold>Enriched <</bold>will not change that, no matter what size display it is shown on. | ||
| 168 | There is no hard/soft newline distinction in unfilled text. | ||
| 169 | |||
| 170 | The most common (for English) style is <<italic>FlushLeft. <</italic>This means | ||
| 171 | lines are aligned at the left margin but left uneven at the | 127 | lines are aligned at the left margin but left uneven at the |
| 172 | right. | 128 | right. |
| 173 | 129 | ||
| 174 | <</nofill><<italic><<flushright>FlushRight<</flushright><</italic><<flushright>, as you may have guessed, makes each line flush with the right margin, | ||
| 175 | but not necessarily the left. | ||
| 176 | |||
| 177 | This is usually, but by no means necessarily, used for headings. | ||
| 178 | |||
| 179 | This paragraph is FlushRight. | ||
| 180 | 130 | ||
| 131 | </nofill><italic><flushright>FlushRight</flushright></italic><flushright> makes each line flush with the right margin instead. | ||
| 181 | 132 | ||
| 182 | <</flushright><<italic><<flushboth>FlushBoth <</flushboth><</italic><<flushboth>regions, which are sometimes called "fully justified" (or, confusingly, | 133 | |
| 183 | "right justified") are aligned evenly on both edges, so that the text on the page | ||
| 184 | has a smooth appearance as in a book or newspaper article. Unfortunately this | ||
| 185 | does not look as nice with a fixed-width font as it does in a | ||
| 186 | proportionally-spaced printed document; the extra spaces that are needed on the | ||
| 187 | screen can make it hard to read. <<indentright><<indentright><<indentright><<indentright> | ||
| 188 | 134 | ||
| 135 | </flushright><italic><flushboth>FlushBoth </flushboth></italic><flushboth>regions, which are sometimes called "fully justified" | ||
| 136 | are aligned evenly on both edges, so that the text on the page has | ||
| 137 | a smooth appearance as in a book or newspaper article. | ||
| 138 | Unfortunately this does not look as nice with a fixed-width font | ||
| 139 | as it does in a proportionally-spaced printed document; the extra | ||
| 140 | spaces that are needed on the screen can make it hard to read. <indentright><indentright><indentright><indentright> | ||
| 189 | 141 | ||
| 190 | <<indent><<indent><<indent><<indent>The narrower the column, the uglier <<italic>FlushBoth | ||
| 191 | <</italic>text will be. If you think <<italic>flushboth <</italic>paragraphs | ||
| 192 | look pretty, though, you can set | ||
| 193 | <<fixed>enriched-default-justification <</fixed>to <<fixed>'both <</fixed>to | ||
| 194 | justify everything that is not otherwise | ||
| 195 | specified. | ||
| 196 | 142 | ||
| 143 | </indentright></indentright></indentright></indentright></flushboth><bold><center>Center | ||
| 197 | 144 | ||
| 198 | <</indent><</indent><</indent><</indent><</indentright><</indentright><</indentright><</indentright><</flushboth><<bold><<center>Center | 145 | </center></bold><center>Finally, there is <italic>center </italic>justification. |
| 146 | The normal center-paragraph key, M-S, can be used to turn on | ||
| 147 | center justification in enriched-mode. | ||
| 199 | 148 | ||
| 200 | <</center><</bold><<center>You can probably guess what <<italic>center <</italic>justification is for. | 149 | M-j or the "Text Properties" menu also can be used to change |
| 150 | justification. | ||
| 201 | 151 | ||
| 202 | The normal center-paragraph key, M-S, can be used to turn on center justification | 152 | |
| 203 | in enriched-mode. M-j also brings up a justification menu. | ||
| 204 | 153 | ||
| 154 | </center><flushboth>Note that justification can only change at hard newlines, because | ||
| 155 | that is the unit over which filling gets done. | ||
| 205 | 156 | ||
| 206 | <</center><<flushboth>Note that justification can only be changed for complete paragraphs (ie, a | ||
| 207 | justified region must start and end at hard newlines). The menu items in the | ||
| 208 | "Justification" menu will all operate on the current paragraph, or, if the region | ||
| 209 | is active, on all paragraphs which are inside or overlapping the region. | ||
| 210 | 157 | ||
| 158 | </flushboth></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>EXCERPTS | ||
| 211 | 159 | ||
| 212 | <</flushboth><</indent><<bold>EXCERPTS<</bold> | 160 | </bold></x-color></x-bg-color> |
| 213 | 161 | ||
| 162 | <excerpt><indent>This is an example of an excerpt. You can use them for quoted | ||
| 163 | parts of other people's email messages and the like. It is just a | ||
| 164 | face, which is the same as the `italic' face by default. | ||
| 165 | </indent></excerpt> | ||
| 214 | 166 | ||
| 215 | <<excerpt><<indent>This is an example of an excerpt. You can use them for quoted parts of other | 167 | <x-bg-color><param>blue</param><x-color><param>white</param><bold>THE FILE FORMAT<indent> |
| 216 | people's email messages and the like. Currently it just displays as italics | ||
| 217 | (unless some <<bold>other<</bold> style is in effect), but this can be changed (see | ||
| 218 | <<underline>Customization<</underline> below). <</indent><</excerpt> | ||
| 219 | 168 | ||
| 169 | </indent></bold></x-color></x-bg-color><indent> | ||
| 220 | 170 | ||
| 221 | <<bold>DEBUGGING<</bold> | 171 | Enriched-mode docuemnts are saved in an extended version of a |
| 172 | format called <italic>text/enriched</italic>, which is defined as part of the MIME | ||
| 173 | standard. This means that your documents are transportable (even | ||
| 174 | through email) to many</indent> <indent>other systems. In the future other file | ||
| 175 | formats may be supported as well. | ||
| 222 | 176 | ||
| 223 | 177 | ||
| 224 | <<indent>The function <<fixed>enriched-show-codes<</fixed> can be helpful in figuring out what is going if | 178 | Since Emacs adds some non-standard features to the format (colors |
| 225 | things don't seem to be working. The function can highlight (with a blue or gray | ||
| 226 | background) various items of interest. <</indent>Type <<fixed>C<<indent>-c C-s<</indent><</fixed><<indent>, then what should be | ||
| 227 | highlighted: | ||
| 228 | 179 | ||
| 180 | and read-only regions), not all systems will be able to recreate | ||
| 181 | all of the features of your document, but they will get as close | ||
| 182 | as possible. | ||
| 229 | 183 | ||
| 230 | <<indent><<bold>indent:<<indent> <</indent><</bold><<indent>Highlight the indentation at the beginning of each line. <</indent> | ||
| 231 | 184 | ||
| 232 | <<bold>margin: <</bold>Highlight regions that are indented. | 185 | The MIME standard is defined in internet RFC 1521; text/enriched |
| 186 | is defined in RFC 1563. Details on obtaining these documents via | ||
| 187 | FTP or email may be obtained by sending an email message to | ||
| 188 | <fixed>rfc-info@isi.edu</fixed> with the message body: | ||
| 233 | 189 | ||
| 234 | <<bold>newline: <</bold>Highlight hard newlines. | 190 | <fixed><indent>help: ways_to_get_rfcs |
| 235 | 191 | ||
| 236 | <<bold>none: <</bold>Turn off all highlighting. <<bold><<excerpt> | ||
| 237 | 192 | ||
| 193 | </indent></fixed>See also the newsgroup comp.mail.mime. | ||
| 238 | 194 | ||
| 239 | <</excerpt><</bold><</indent><</indent><<bold>CUSTOMIZATION | ||
| 240 | 195 | ||
| 196 | </indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>CUSTOMIZATION | ||
| 241 | 197 | ||
| 242 | <</bold><<indent>-<<indent> Set the default faces to things you like. The faces named <<fixed>fixed <</fixed>and <<excerpt>excerpt, | 198 | </bold></x-color></x-bg-color><bold> |
| 243 | <</excerpt>especially, can be set to your liking. <</indent> | ||
| 244 | 199 | ||
| 245 | - <<indent>User-preference variables: <<fixed>enriched-default-right-margin, | 200 | </bold><indent>-<indent> The <fixed>fixed </fixed>and <excerpt>excerpt </excerpt>faces should be set to your liking.</indent> |
| 246 | enriched-default-justification, enriched-verbose, | ||
| 247 | enriched-auto-save-interval<</fixed><<bold>, <</bold>and <<fixed>enriched-fill-after-visiting <</fixed>(mentioned | ||
| 248 | above)<<bold>. <</bold>See their documentation for det<</indent>ails. | ||
| 249 | 201 | ||
| 250 | - <<indent>You can add annotations for your own text properties by making additions to | 202 | - <indent>User-preference variables: <fixed>default-justification, enriched-verbose. |
| 251 | <<fixed>enriched-annotation-alist<</fixed>. Note that the standard requires you to name your | 203 | </fixed></indent>- <indent>You can add annotations for your own text properties by making |
| 252 | annotation starting<<italic> "x-" <</italic>(as in <<italic>"x-read-only"<</italic>). Please send me any such | 204 | additions to <fixed>enriched-annotation-alist</fixed>. Note that the |
| 253 | additions that you think might be of general interest so that I can include | 205 | standard requires you to name your annotation starting<italic> "x-" |
| 254 | them in the distribution. | 206 | </italic>(as in <italic>"x-read-only"</italic>). Please send me any such additions that |
| 207 | you think might be of general interest so that I can include | ||
| 208 | them in the distribution. | ||
| 255 | 209 | ||
| 256 | <</indent>- <<indent>My eventual hope is that people will use the basic code in this file to | ||
| 257 | implement more of the various file formats that are in common use, so that | ||
| 258 | emacs will understand them all and be able to edit them with a common | ||
| 259 | interface. If you are interested in taking on the project of implementing a | ||
| 260 | format, let me know. The code attempts to be as general as possible; a lot | ||
| 261 | of different formats can be defined just by setting up the lists of | ||
| 262 | properties to save and how to represent them in the file. | ||
| 263 | 210 | ||
| 211 | </indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>TO-DO LIST | ||
| 264 | 212 | ||
| 265 | <</indent><</indent><<bold>TO-DO LIST | 213 | </bold></x-color></x-bg-color><bold> |
| 266 | 214 | ||
| 215 | </bold><indent><italic>[Feel free to work on these and send me the results!]</italic> | ||
| 267 | 216 | ||
| 268 | <</bold><<indent><<italic>[Feel free to work on these and send me the results!] <</italic> | 217 | - Be smarter about fixing malformed files. |
| 269 | |||
| 270 | - Be more tolerant of malformed files. | ||
| 271 | 218 | ||
| 272 | - Make the indentation work more seamlessly and robustly: | 219 | - Make the indentation work more seamlessly and robustly: |
| 273 | 220 | ||
| 274 | <<indent>+ Create<<indent> an aggressive auto-fill function that will keep the paragraph | 221 | <indent>+ Create<indent> an aggressive auto-fill function that will keep the |
| 275 | properly filled all the time, without slowing down editing too much. <</indent> | 222 | paragraph properly filled all the time, without slowing |
| 276 | 223 | down editing too much.</indent> | |
| 277 | + Refill after yank. | ||
| 278 | |||
| 279 | + <<indent>Make deleting a newline also delete the indentation following it. <</indent> | ||
| 280 | |||
| 281 | + Never let point enter indentation?? | ||
| 282 | |||
| 283 | +<<indent> Optional never-let-things-get-unfilled (ok for fast terminals). <</indent> | ||
| 284 | |||
| 285 | <</indent>- Do the right thing for insert-file. | ||
| 286 | |||
| 287 | - Notice and re-fill when window changes widths (optionally). - Nicer formatting | ||
| 288 | for excerpts. | ||
| 289 | |||
| 290 | - Interface w/ GNUS, VM, RMAIL. | ||
| 291 | |||
| 292 | - For documentation, make INFO aware of text/enriched format. | ||
| 293 | |||
| 294 | -<<indent> Have another set of alists for reading and writing RTF, etc (this will take | ||
| 295 | work not only on the alists, of course, but also on the code for interpreting | ||
| 296 | them). | ||
| 297 | 224 | ||
| 225 | + Refill after yank. | ||
| 298 | 226 | ||
| 227 | + <indent>Make deleting a newline also delete the indentation | ||
| 228 | following it.</indent> | ||
| 299 | 229 | ||
| 300 | <</indent><</indent><<bold>Final Notes: | 230 | + Never let point enter indentation?? |
| 301 | 231 | ||
| 232 | </indent>- Notice and re-fill when window changes widths (optionally). | ||
| 302 | 233 | ||
| 303 | <</bold><<indent>The MIME standard is defined in internet RFC 1521; text/enriched is defined in | 234 | - Deal with the `category' text-property in a smart way. |
| 304 | RFC 1563. Details on obtaining these documents via FTP or email may be obtained | ||
| 305 | by sending an email message to <<fixed>rfc-info@isi.edu<</fixed> with the message body: | ||
| 306 | 235 | ||
| 307 | <<indent> <<fixed>help: ways_to_get_rfcs <</fixed> <</indent> | 236 | - Interface w/ GNUS, VM, RMAIL. Maybe Info too? |
| 308 | 237 | ||
| 238 | -<indent> Support more formats: RTF, HTML... | ||
| 309 | 239 | ||
| 310 | This code and documentation is under development. The most current version | ||
| 311 | should always be available from: | ||
| 312 | 240 | ||
| 313 | <<indent><<fixed>/anonymous@cs.rochester.edu:pub/boris/enriched.shar<</fixed> | 241 | </indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>Final Notes: |
| 314 | 242 | ||
| 315 | <</indent>It is helpful to make sure you have the newest version before reporting a bug. | 243 | </bold></x-color></x-bg-color><bold> |
| 316 | 244 | ||
| 317 | <</indent>Please send any and all comments to: | 245 | </bold><indent>This code and documentation is under development. |
| 246 | </indent>Comments and bug reports are welcome. | ||
| 318 | 247 | ||
| 319 | 248 | ||
| 320 | <<bold><<x-color><<param>blue<</param>Boris Goldowsky <</x-color><</bold><<fixed><<<<boris@cs.rochester.edu><</fixed><<x-color><<param>blue<</param> | 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> |
| 321 | 250 | ||
| 322 | October 1994 | 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> |
| 323 | 252 | ||
| 324 | 253 | ||
| 325 | 254 | ||
| @@ -331,4 +260,4 @@ October 1994 | |||
| 331 | 260 | ||
| 332 | 261 | ||
| 333 | 262 | ||
| 334 | <</x-color> | 263 | </x-color> |