X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/94684a2e921fb5326d102f613b7ba1eb6f7928b3..ff6a3bfb4081a5319c344e0778aafcde429c2ea7:/etc/enriched.doc diff --git a/etc/enriched.doc b/etc/enriched.doc index f13962fe37..ff57087c98 100644 --- a/etc/enriched.doc +++ b/etc/enriched.doc @@ -6,32 +6,30 @@ Text-Width: 70 bluewhiteWYSIWYG rich text editing for GNU Emacs -bluewhiteINTRODUCTION +bluewhiteINTRODUCTION - -Emacs now has the ability to edit enriched text, which is text -containing faces, colors, indentation, and other properties. -This document is a quick introduction to some of the new features, -and is also an example file in the text/enriched format. +Emacs now has the ability to edit enriched text, which is text +containing faces, colors, indentation, and other properties. This +document is a quick introduction to some of the new features, and +is also an example file in the text/enriched format. -bluewhiteINSTALLATION and STARTUP - +bluewhiteINSTALLATION and STARTUP + Most of the time, you need not do anything to get these features to work. If you visit a file that has been written out in text/enriched format, it will automatically be decoded, Emacs will enter `enriched-mode' while visiting it, and whenever you save it it will be saved in the same format it was read in. - If you wish to create a new file, however, you will need to turn on enriched-mode yourself: -M-x enriched-mode RET +M-x enriched-mode RET Or, if you get a text/enriched file that Emacs does not @@ -39,225 +37,220 @@ automatically recognize and decode, you can tell Emacs to decode it (which also turns on enriched-mode automatically): - M-x format-decode-buffer RET text/enriched RET +M-x format-decode-buffer RET text/enriched RET -bluewhiteWHAT IS ENCODED +bluewhiteWHAT IS ENCODED - -Here is the current list of text-properties that are saved; they -are discussed in more detail below. -Most of these can be added or changed with the "Text Properties" -menu, available under the "Edit" item in the menu-bar, or on -C-mouse-2 (Control + the middle mouse button). +Here is the current list of text-properties that are saved; they +are discussed in more detail below. Most of these can be added or +changed with the "Text Properties" menu, available under the +"Edit" item in the menu-bar, or on C-mouse-2 (Control + the middle +mouse button). -Faces: default, bold, italic, underline, fixed, etc. +Faces: default, bold, italic, underline, etc. -Colors: redDarkSlateGrayanyDarkSlateGrayorangething yellowyourgreen screenblue light bluecanviolet display... +Colors: redDarkSlateGrayanyDarkSlateGrayorangething yellowyourgreen screenblue light bluecanviolet display... Newlines: Which ones are real ("hard") newlines, and which can be -changed to fit lines into the margins. +changed to fit lines into the margins. -Margins: can be indented on the left or right. +Margins: can be indented on the left or right. -Justification (whether lines should be flush with the left margin, -the right margin, fully justified, centered, or left alone). +Justification (whether lines should be flush with the left margin, +the right margin, fully justified, centered, or left alone). -Excerpts: "For quoted material." +Excerpts: "For quoted material." Read-only regions. + -bluewhiteFACES and COLORS +bluewhiteFACES and COLORS - -You can add faces either with the menu or with M-g. The face is +You can add faces either with the menu or with M-g. The face is applied to the current region. If you are using `transient-mark-mode' and the region is not active, then the face -applies to whatever you type next. Any face can have colors, but -faces have no other attributes are put on the color submenus of -the "Text Properties" menu. +applies to whatever you type next. Any face can have colors. If +this is its lone attribute, the face is put on the color submenus +of the "Text Properties" menu. -bluewhiteNEWLINES and PARAGRAPHS +bluewhiteNEWLINES and PARAGRAPHS - -Text/enriched format distinguishes between hard and soft newlines. +Text/enriched format distinguishes between hard and soft 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 margins are. Soft newlines are the ones inserted in order to fit text between the margins. The fill and auto-fill functions insert soft newlines as necessary, but hard newlines are only inserted by direct request, such as using the return key or the C-o -(open-line) function. +(open-line) function. + +bluewhiteINDENTATION -bluewhiteINDENTATION - +The fill functions also understand margins, which can be set for +any region of a document. In addition to the menu items, which +increase or decrease the margins, there are two commands for +setting the margins absolutely: C-c C-l (set-left-margin) and C-c +C-r (set-right-margin). -The fill functions also understand margins, which can be set -for any region of a document. In addition to the menu items, -which increase or decrease the margins, there are two commands -for setting the margins absolutely: C-c l (set-left-margin) -and C-c r (set-right-margin). - -You can change indentation at any point in a paragraph, which -makes it possible to do interesting things like -hanging-indents: this paragraph was indented by selecting the +You can change indentation at any point in a paragraph, which +makes it possible to do interesting things like +hanging-indents: this paragraph was indented by selecting the region from the second word to the end of the paragraph, and -indenting only that part. +indenting only that part. - -bluewhiteJUSTIFICATION +bluewhiteJUSTIFICATION - -Several styles of justification are possible, the simplest being unfilled. + +Several styles of justification are possible, the simplest being unfilled. This means that your lines will be left as you write them. -This paragraph is unfilled. +This paragraph is unfilled. + -The most common (for English) style is FlushLeft. This means -lines are aligned at the left margin but left uneven at the -right. +The most common (for English) style is FlushLeft. This means +lines are aligned at the left margin but left uneven at the right. - FlushRight makes each line flush with the right margin instead. + FlushRight makes each line flush with the right margin instead. + This paragraph is FlushRight. -FlushBoth regions, which are sometimes called "fully justified" +FlushBoth regions, which are sometimes called "fully justified" are aligned evenly on both edges, so that the text on the page has a smooth appearance as in a book or newspaper article. Unfortunately this does not look as nice with a fixed-width font as it does in a proportionally-spaced printed document; the extra -spaces that are needed on the screen can make it hard to read. +spaces that are needed on the screen can make it hard to read. +
-
Center + Center -
Finally, there is center justification. - The normal center-paragraph key, M-S, can be used to turn on - center justification in enriched-mode. + Finally, there is center 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 + M-j or the "Text Properties" menu also can be used to change justification.
Note that justification can only change at hard newlines, because -that is the unit over which filling gets done. +that is the unit over which filling gets done. -bluewhiteEXCERPTS +bluewhiteEXCERPTS - This is an example of an excerpt. You can use them for quoted parts of other people's email messages and the like. It is just a -face, which is the same as the `italic' face by default. - +face, which is the same as the `italic' face by default. -bluewhiteTHE FILE FORMAT - +bluewhiteTHE FILE FORMAT -Enriched-mode documents are saved in an extended version of a + +Enriched-mode documents are saved in an extended version of a format called text/enriched, which is defined as part of the MIME standard. This means that your documents are transportable (even -through email) to many other systems. In the future other file +through email) to many other systems. In the future other file formats may be supported as well. Since Emacs adds some non-standard features to the format (colors - and read-only regions), not all systems will be able to recreate all of the features of your document, but they will get as close -as possible. +as possible. -The MIME standard is defined in internet RFC 1521; text/enriched +The MIME standard is defined in Internet RFC 1521; text/enriched is defined in RFC 1563. Details on obtaining these documents via FTP or email may be obtained by sending an email message to rfc-info@isi.edu with the message body: -help: ways_to_get_rfcs +help: ways_to_get_rfcs -See also the newsgroup comp.mail.mime. +See also the newsgroup comp.mail.mime. -bluewhiteCUSTOMIZATION - +bluewhiteCUSTOMIZATION + - The fixed and excerpt faces should be set to your liking. -- User-preference variables: default-justification, enriched-verbose. -- You can add annotations for your own text properties by making +- User-preference variables: default-justification, +enriched-verbose. + +- You can add annotations for your own text properties by making additions to enriched-annotation-alist. Note that the standard requires you to name your annotation starting "x-" (as in "x-read-only"). Please send me any such additions that you think might be of general interest so that I can include -them in the distribution. +them in the distribution. + -bluewhiteTO-DO LIST +bluewhiteTO-DO LIST - -[Feel free to work on these and send me the results!] +[Feel free to work on these and send me the results!] -- Be smarter about fixing malformed files. ++ Conform to updated text/enriched spec in RFC 1896. -- Make the indentation work more seamlessly and robustly: ++ Be smarter about fixing malformed files. -+ Create an aggressive auto-fill function that will keep the -paragraph properly filled all the time, without slowing -down editing too much. ++ Make the indentation work more seamlessly and robustly: -+ Refill after yank. ++ Create an aggressive auto-fill function that will keep the +paragraph properly filled all the time, without slowing down +editing too much. Refill mode is a start at this, but needs -+ Make deleting a newline also delete the indentation -following it. + improvment. -+ 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... ++ Refill after yank. [Refill mode does that.] ++ Make deleting a newline also delete the indentation following +it. -bluewhiteFinal Notes: - - ++ Never let point enter indentation?? -This code and documentation is under development. - Comments and bug reports are welcome. ++ Notice and re-fill when window changes widths (optionally). ++ Deal with the `category' text-property in a smart way. -whiteblueBoris Goldowskylight blue light blue<blue ++ Interface w/ Gnus, VM, RMAIL. Maybe Info too? (Gnus 5.9 copes -bluewhite April 1995 blue + with text/enriched incoming mail.) ++ Support more formats: RTF, HTML... ++ Use Emacs 21 display features. + +bluewhiteFinal Notes: +This code and documentation is under development. Comments and +bug reports are welcome. +whiteblueBoris Goldowskylight blue light blue<blue +bluewhiteApril 1995; updated August 1997 -