Content-Type: text/enrichedText-Width: 70<center><x-bg-color><param>blue</param><x-color><param>white</param><bold><fixed>enriched.el:</fixed></bold></x-color></x-bg-color><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></center><bold><x-bg-color><param>blue</param><x-color><param>white</param>INTRODUCTION</x-color></x-bg-color></bold><indent>Emacs now has the ability to edit <italic>enriched text</italic>, which is textcontaining faces, colors, indentation, and other properties. Thisdocument is a quick introduction to some of the new features, andis also an example file in the <italic>text/enriched </italic>format.</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INSTALLATION and STARTUP</bold></x-color></x-bg-color><indent>Most of the time, you need not do anything to get these featuresto work. If you visit a file that has been written out in<italic>text/enriched</italic> format, it will automatically be decoded, Emacs willenter `enriched-mode' while visiting it, and whenever you save itit will be saved in the same format it was read in.If you wish to create a new file, however, you will need to turnon enriched-mode yourself:<fixed><indent>M-x enriched-mode RET</indent></fixed>Or, if you get a <italic>text/enriched </italic>file that Emacs does notautomatically recognize and decode, you can tell Emacs to decodeit (which also turns on enriched-mode automatically):<fixed><indent>M-x format-decode-buffer RET text/enriched RET</indent></fixed></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>WHAT IS ENCODED</bold></x-color></x-bg-color><indent>Here is the current list of text-properties that are saved; theyare discussed in more detail below. Most of these can be added orchanged with the "Text Properties" menu, available under the"Edit" item in the menu-bar, or on C-mouse-2 (Control + the middlemouse button).<bold>Faces:</bold> <indent>default, <bold>bold</bold>, <italic>italic</italic>, <underline>underline</underline>, etc.</indent><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><bold>Newlines:</bold> <indent>Which ones are real ("hard") newlines, and which can bechanged to fit lines into the margins.</indent><bold>Margins:</bold> <indent>can be indented on the left or right.</indent><bold>Justification</bold> <indent>(whether lines should be flush with the left margin,the right margin, fully justified, centered, or left alone).</indent><bold>Excerpts:</bold><indent> <excerpt>"For quoted material."</excerpt></indent><bold>Read-only</bold> regions.</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>FACES and COLORS</bold></x-color></x-bg-color><indent>You can add faces either with the menu or with <fixed>M-g.</fixed> The face isapplied to the current region. If you are using`transient-mark-mode' and the region is not active, then the faceapplies to whatever you type next. Any face can have colors, butfaces have no other attributes are put on the color submenus ofthe "Text Properties" menu.</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>NEWLINES and PARAGRAPHS</bold></x-color></x-bg-color><italic><indent>Text/enriched</indent></italic><indent> format distinguishes between <underline>hard</underline> and <underline>soft</underline> newlines.Hard newlines are used to separate paragraphs, or items in a list,or anywhere that must be a line break no matter what the marginsare. Soft newlines are the ones inserted in order to fit textbetween the margins. The fill and auto-fill functions insert softnewlines as necessary, but hard newlines are only inserted bydirect request, such as using the return key or the <fixed>C-o(open-line)</fixed> function.</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INDENTATION</bold></x-color></x-bg-color><indent>The fill functions also understand margins, which can be set forany region of a document. In addition to the menu items, whichincrease or decrease the margins, there are two commands forsetting the margins absolutely: <fixed>C-c C-l (set-left-margin)</fixed> and <fixed>C-cC-r (set-right-margin)</fixed>.You <indent>can change indentation at any point in a paragraph, whichmakes it possible to do interesting things likehanging-indents: this paragraph was indented by selecting theregion from the second word to the end of the paragraph, andindenting only that part.</indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>JUSTIFICATION</bold></x-color></x-bg-color><indent><nofill>Several styles of justification are possible, the simplest being <italic>unfilled. </italic>This means that your lines will be left as you write them. This paragraph is unfilled.</nofill><flushleft>The most common (for English) style is <italic>FlushLeft. </italic>This meanslines are aligned at the left margin but left uneven at the right.</flushleft><flushright> <italic>FlushRight</italic> makes each line flush with the right margin instead. This paragraph is FlushRight.</flushright><flushboth><italic>FlushBoth </italic>regions, which are sometimes called "fully justified"are aligned evenly on both edges, so that the text on the page hasa smooth appearance as in a book or newspaper article. Unfortunately this does not look as nice with a fixed-width fontas it does in a proportionally-spaced printed document; the extraspaces that are needed on the screen can make it hard to read. </flushboth><center> <bold>Center</bold> Finally, there is <italic>center </italic>justification. The normal center-paragraph key, M-S, can be used to turn on center justification in enriched-mode. M-j or the "Text Properties" menu also can be used to change justification.</center><flushboth>Note that justification can only change at hard newlines, becausethat is the unit over which filling gets done. </flushboth></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>EXCERPTS</bold></x-color></x-bg-color><excerpt><indent>This is an example of an excerpt. You can use them for quotedparts of other people's email messages and the like. It is just aface, which is the same as the `italic' face by default.</indent></excerpt><x-bg-color><param>blue</param><x-color><param>white</param><bold>THE FILE FORMAT</bold></x-color></x-bg-color><indent>Enriched-mode documents are saved in an extended version of aformat called <italic>text/enriched</italic>, which is defined as part of the MIMEstandard. This means that your documents are transportable (eventhrough email) to many other systems. In the future other fileformats may be supported as well.Since Emacs adds some non-standard features to the format (colorsand read-only regions), not all systems will be able to recreateall of the features of your document, but they will get as closeas possible.The MIME standard is defined in </indent>Internet<indent> RFC 1521; text/enrichedis defined in RFC 1563. Details on obtaining these documents viaFTP or email may be obtained by sending an email message to<fixed>rfc-info@isi.edu</fixed> with the message body:<fixed><indent>help: ways_to_get_rfcs</indent></fixed><indent>See also the newsgroup <fixed>comp.mail.mime</fixed>.</indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>CUSTOMIZATION</bold></x-color></x-bg-color><bold></bold><indent>-<indent> The <fixed>fixed </fixed>and <excerpt>excerpt </excerpt>faces should be set to your liking.</indent>-<indent> User-preference variables: <fixed>default-justification,enriched-verbose.</fixed></indent>-<indent> You can add annotations for your own text properties by makingadditions to <fixed>enriched-annotation-alist</fixed>. Note that thestandard requires you to name your annotation starting<italic> "x-"</italic>(as in <italic>"x-read-only"</italic>). Please send me any such additions thatyou think might be of general interest so that I can includethem in the distribution.</indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>TO-DO LIST</bold></x-color></x-bg-color><italic><indent>[Feel free to work on these and send me the results!]</indent></italic><indent>+ Conform to updated text/enriched spec in RFC 1896.+ Be smarter about fixing malformed files.+ Make the indentation work more seamlessly and robustly:+ Create<indent> an aggressive auto-fill function that will keep theparagraph properly filled all the time, without slowing downediting too much.</indent>+ Refill after yank.+<indent> Make deleting a newline also delete the indentation followingit.</indent>+ Never let point enter indentation??+ Notice and re-fill when window changes widths (optionally).+ Deal with the `category' text-property in a smart way.+ Interface w/ GNUS, VM, RMAIL. Maybe Info too?+ Support more formats: RTF, HTML...</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>Final Notes:</bold></x-color></x-bg-color><indent>This code and documentation is under development. Comments andbug reports are welcome.</indent><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></x-color><x-bg-color><param>blue</param><x-color><param>white</param>April 1995; updated August 1997</x-color></x-bg-color>