]> code.delx.au - gnu-emacs/blobdiff - etc/enriched.doc
(Advising Functions): Don't imply one part of Emacs
[gnu-emacs] / etc / enriched.doc
index f13962fe379c53b640ad7642a1174796e801f034..122652f005a1c7b834d59fb612c41eeb205d6e8f 100644 (file)
@@ -6,32 +6,30 @@ Text-Width: 70
 <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
+</center><bold><x-bg-color><param>blue</param><x-color><param>white</param>INTRODUCTION</x-color></x-bg-color></bold>
 
-</x-color></x-bg-color>
 
-</bold><indent>Emacs now has the ability to edit <italic>enriched text</italic>, 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 <italic>text/enriched </italic>format.
 
+<indent>Emacs now has the ability to edit <italic>enriched text</italic>, 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 <italic>text/enriched </italic>format.</indent>
 
-</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INSTALLATION and STARTUP
 
-</bold></x-color></x-bg-color>
+<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 features
 to work.  If you visit a file that has been written out in
 <italic>text/enriched</italic> 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:
 
 
-<fixed><indent>M-x enriched-mode  RET</indent></fixed>
+<fixed><indent>M-x enriched-mode RET</indent></fixed>
 
 
 Or, if you get a <italic>text/enriched </italic>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):
 
 
-    <fixed>M-x format-decode-buffer  RET  text/enriched  RET</fixed>
+<fixed><indent>M-x format-decode-buffer RET text/enriched RET</indent></fixed></indent>
 
     
 
-</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold><flushleft>WHAT IS ENCODED
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>WHAT IS ENCODED</bold></x-color></x-bg-color>
 
-</flushleft></bold></x-color></x-bg-color><flushleft>
 
-</flushleft><indent>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).
+<indent>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).
 
-<bold>Faces:</bold> default, <bold>bold</bold>, <italic>italic</italic>, <underline>underline</underline>, <fixed>fixed</fixed>, etc.
+<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>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>
+<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 be
-changed to fit lines into the ma</indent>rgins.
+changed to fit lines into the margins.</indent>
 
-<bold>Margins:</bold> can be indented on the left or right.
+<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 alo</indent>ne).
+<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><excerpt>For quoted material."</excerpt>
+<bold>Excerpts:</bold><indent> <excerpt>"For quoted material."</excerpt></indent>
 
 <bold>Read-only</bold> regions.
 
+</indent>
 
-</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>FACES and COLORS
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>FACES and COLORS</bold></x-color></x-bg-color>
 
-</bold></x-color></x-bg-color><bold>
 
-</bold><indent>You can add faces either with the menu or with <fixed>M-g.</fixed>  The face is
+<indent>You can add faces either with the menu or with <fixed>M-g.</fixed>  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.</indent>
 
 
-</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>NEWLINES and PARAGRAPHS
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>NEWLINES and PARAGRAPHS</bold></x-color></x-bg-color>
 
-</bold></x-color></x-bg-color><bold>
 
-</bold><indent><italic>Text/enriched</italic> format distinguishes between <underline>hard</underline> and <underline>soft</underline> newlines.
+<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 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 <fixed>C-o
-(open-line)</fixed> function.
+(open-line)</fixed> function.</indent>
 
 
-</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>INDENTATION
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>INDENTATION</bold></x-color></x-bg-color>
 
-</bold></x-color></x-bg-color><bold>
 
-</bold><indent><indentright>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: <fixed>C-c l (set-left-margin)</fixed>
-and <fixed>C-c r (set-right-margin)</fixed>. 
-<flushleft>
+<indent>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: <fixed>C-c [ (set-left-margin)</fixed> and <fixed>C-c
+] (set-right-margin)</fixed>.
 
-</flushleft></indentright><flushleft>You <indent>can change indentation at any point in a</indent></flushleft></indent> <indent><indent><flushleft>paragraph, which
-makes it possible to do interesting things like</flushleft>
-<flushleft>hanging-indents: this paragraph was indented by selecting the
+
+You <indent>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.<indent>
+indenting only that part.</indent></indent>
+
 
-</indent></flushleft></indent></indent><flushleft>
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>JUSTIFICATION</bold></x-color></x-bg-color>
 
-<x-bg-color><param>blue</param><x-color><param>white</param><bold>JUSTIFICATION<indent>
 
-</indent></bold></x-color></x-bg-color><bold><indent>
 
-</indent></bold></flushleft><indent><nofill>Several styles of justification are possible, the simplest being <italic>unfilled. 
+<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.
+This paragraph is unfilled.</nofill>
 
-The most common (for English) style is <italic>FlushLeft.  </italic>This means
-lines are aligned at the left margin but left uneven at the
-right.
 
+<flushleft>The most common (for English) style is <italic>FlushLeft.  </italic>This means
+lines are aligned at the left margin but left uneven at the right.</flushleft>
 
-   </nofill><italic><flushright>FlushRight</flushright></italic><flushright> makes each line flush with the right margin instead.
+
+<flushright>    <italic>FlushRight</italic> makes each line flush with the right margin instead.
+    This paragraph is FlushRight.</flushright>
 
     
 
-</flushright><italic><flushboth>FlushBoth </flushboth></italic><flushboth>regions, which are sometimes called "fully justified"
+<flushboth><italic>FlushBoth </italic>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. <indentright><indentright><indentright><indentright>
+spaces that are needed on the screen can make it hard to read. </flushboth>
 
+<center>    
 
-    </indentright></indentright></indentright></indentright></flushboth><bold><center>Center
+    <bold>Center</bold>
 
-    </center></bold><center>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.
+    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
+    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, because
-that is the unit over which filling gets done. 
+that is the unit over which filling gets done. </flushboth></indent>
 
 
-</flushboth></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>EXCERPTS
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>EXCERPTS</bold></x-color></x-bg-color>
 
-</bold></x-color></x-bg-color>
 
 <excerpt><indent>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.
-    </indent></excerpt>
+face, 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<indent>
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>THE FILE FORMAT</bold></x-color></x-bg-color>
 
-</indent></bold></x-color></x-bg-color><indent>
 
-Enriched-mode documents are saved in an extended version of a
+<indent>Enriched-mode documents are saved in an extended version of a
 format called <italic>text/enriched</italic>, which is defined as part of the MIME
 standard.  This means that your documents are transportable (even
-through email) to many</indent> <indent>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 </indent>Internet<indent> 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
 <fixed>rfc-info@isi.edu</fixed> with the message body:
 
-<fixed><indent>help: ways_to_get_rfcs
-
 
-</indent></fixed>See also the newsgroup comp.mail.mime. 
+<fixed><indent>help: ways_to_get_rfcs</indent></fixed>
 
 
-</indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>CUSTOMIZATION
+<indent>See also the newsgroup <fixed>comp.mail.mime</fixed>.</indent></indent>
 
-</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 making
-additions to <fixed>enriched-annotation-alist</fixed>.  Note that the
-standard requires you to name your annotation starting<italic> "x-"
-</italic>(as in <italic>"x-read-only"</italic>).  Please send me any such additions that
-you think might be of general interest so that I can include
-them in the distribution.
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>CUSTOMIZATION</bold></x-color></x-bg-color><bold>
 
 
-</indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>TO-DO LIST
-
-</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>
 
-</bold><indent><italic>[Feel free to work on these and send me the results!]</italic>
+-<indent> User-preference variables: <fixed>default-justification,
+enriched-verbose.
 
-- Be smarter about fixing malformed files.
+</fixed></indent>-<indent> You can add annotations for your own text properties by making
+additions to <fixed>enriched-translations</fixed>.  Note that the standard
+requires you to name your annotation starting<italic> "x-" </italic>(as in
+<italic>"x-read-only"</italic>).  Please send me any such additions that you
+think might be of general interest so that I can include them
+in the distribution.</indent>
 
-- Make the indentation work more seamlessly and robustly:
+</indent>
 
-<indent>+ Create<indent> an aggressive auto-fill function that will keep the
-paragraph properly filled all the time, without slowing
-down editing too much.</indent>
+<x-bg-color><param>blue</param><x-color><param>white</param><bold>TO-DO LIST</bold></x-color></x-bg-color>
 
-+ Refill after yank.
 
-+ <indent>Make deleting a newline also delete the indentation
-following it.</indent>
+<italic><indent>[Feel free to work on these and send me the results!]</indent></italic><indent>
 
-+ Never let point enter indentation??
++ Conform to updated text/enriched spec in RFC 1896.
 
-</indent>- Notice and re-fill when window changes widths (optionally).
++ Be smarter about fixing malformed files.
 
-- Deal with the `category' text-property in a smart way.
++ Make the indentation work more seamlessly and robustly:
 
-- Interface w/ GNUS, VM, RMAIL.  Maybe Info too?
++ Create<indent> 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
 
--<indent> Support more formats: RTF, HTML...
+</indent></indent>     <indent>improvment.
 
++ Refill after yank.  [Refill mode does that.]
 
-</indent></indent><x-bg-color><param>blue</param><x-color><param>white</param><bold>Final Notes:
++<indent> Make deleting a newline also delete the indentation following
+it.</indent>
 
-</bold></x-color></x-bg-color><bold>
++ Never let point enter indentation??
 
-</bold><indent>This code and documentation is under development.
-    </indent>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.
 
-<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>
++ Interface w/ Gnus, VM, RMAIL.  Maybe Info too?  </indent>(Gnus 5.9 copes
 
-</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>
+      with text/enriched incoming mail.)<indent>
 
++ Support more formats: RTF, HTML...
 
++ Use Emacs 21 display features.
 
+</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 and
+bug 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>
 
 
-</x-color>