[PATCH] Documentation for message window



Hi all,

I noticed that the Message Window section of the help file was empty, so I wrote the included patch. I've also attached the necessary image files which go in doc/C/figures.

By the way, when I select Help->Contents, I get the following errors in the invoking terminal window:

  Unmatched element: releaseinfo
  Unmatched element: pubdate
  Unmatched element: q

The elements appear to be valid.
Does anyone else see this, or is it just my setup?

diff -r -u balsa/doc/C/balsa.xml localBalsa/doc/C/balsa.xml
--- balsa/doc/C/balsa.xml	2005-08-16 21:42:16.000000000 -0400
+++ localBalsa/doc/C/balsa.xml	2005-08-17 22:36:45.000000000 -0400
@@ -2127,8 +2127,81 @@
 <!-- ################################################################# -->
 <sect1 id="win-message">
 <title>The Message Window</title>
-<para>To be filled in.</para>
+
+<para>
+  In addition to the preview pane, &Balsa; can display messages in
+  separate windows.  Simply double-click on the desired message from
+  the message index in the main window.  Any number of windows may be
+  opened, although only one per unique message.
+</para>
+
+<para>
+  The message window has a menu and toolbar containing commands
+  pertinent to an individual message.  Commands are as described in
+  the <link linkend="win-main"><interface>main window</interface></link>.
+  Below the menu and toolbar are the message headers in a box,
+  followed by the message body.
+</para>
+
+<figure>
+  <title>Message Window</title>
+  <screenshot>
+	  <mediaobject> 
+	    <imageobject><imagedata
+		fileref="figures/message-window.png" format="PNG"/> 
+	    </imageobject>
+	  </mediaobject>
+  </screenshot>
+</figure>
+
+<para>
+  If your copy of &Balsa; has cryptographic support, there will be
+  an icon in the header box depicting an envelope with a lock and a
+  check mark.  Clicking the icon will check the key used to sign the
+  message.  The message body will contain an icon and some
+  descriptive text noting whether the signing key is valid, invalid,
+  or unchecked.
+</para>
+
+<para>
+  If the message contains attachments or more than one part of any
+  kind, an attachment icon will be present in the header box as
+  shown below.  Clicking this icon will show a menu of all available
+  parts.  Selecting a part will update the display of the message
+  body accordingly.
+</para>
+
+<figure>
+  <title>Selecting a Message Part</title>
+  <screenshot>
+	  <mediaobject> 
+	    <imageobject><imagedata
+		fileref="figures/msg-part-select.png" format="PNG"/> 
+	    </imageobject>
+	  </mediaobject>
+  </screenshot>
+</figure>
+
+<para>
+  The "complete message" selection will do it's best to render all
+  parts at once, but some may have to be selected individually or
+  opened in an external program.  Parts which cannot be rendered
+  within &Balsa; will instead display a list of options for opening
+  external programs or saving the data.  Right-clicking on a part
+  will also provide a menu with these options.
+</para>
+
+<para>
+  Navigation between messages is possible without returning to the
+  index in the main window.  Next unread being quite useful for
+  checking all new mail.  Deleting the current message will
+  automatically display the next unread one.  This behavior can be
+  changed in the <link linkend="preferences">
+  <interface>preferences</interface></link>.
+</para>
+
 </sect1>
+
 <!-- ################################################################# -->
 <!--                 SECTION: PREFERENCES                              -->
 <!-- ################################################################# -->

Attachment: message-window.png
Description: PNG image

Attachment: msg-part-select.png
Description: PNG image



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]