diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/C/apx-gloss.sgml | 30 | ||||
| -rw-r--r-- | doc/C/evolution-guide.sgml | 18 | ||||
| -rw-r--r-- | doc/C/menuref.sgml (renamed from doc/C/apx-menuref.sgml) | 140 | ||||
| -rw-r--r-- | doc/C/preface.sgml | 13 | ||||
| -rw-r--r-- | doc/C/usage-mail.sgml | 232 | ||||
| -rw-r--r-- | doc/C/usage-mainwindow.sgml | 52 |
6 files changed, 262 insertions, 223 deletions
diff --git a/doc/C/apx-gloss.sgml b/doc/C/apx-gloss.sgml index 0f1b73ff09..5693ecda1c 100644 --- a/doc/C/apx-gloss.sgml +++ b/doc/C/apx-gloss.sgml @@ -227,6 +227,22 @@ </glossdef> </glossentry> + <glossentry id="regular-expression"> + <glossterm>Regular Expression</glossterm> + <glossdef> + <para> + A regular expression, or "regex", is a way of describing a + string of text using metacharacters or wildcard symbols. For + example, the statement <userinput>fly*so[a|u]p</userinput> means + "any phrase beginning with 'fly' and ending in 'soup' or + 'soap'". If you searched for that expression, you'd find both + "fly in my soup" and "fly in my soap." There's not room here to + go into depth, but if you want, have a look at the documentation + for the <command>grep</command> command. + </para> + </glossdef> + </glossentry> + <glossentry id="script"> <glossterm>Script</glossterm> <glossdef> @@ -282,3 +298,17 @@ </glossentry> </glossary> + + + + + + + + + + + + + + diff --git a/doc/C/evolution-guide.sgml b/doc/C/evolution-guide.sgml index f7a7a87ab2..0eff8b99a0 100644 --- a/doc/C/evolution-guide.sgml +++ b/doc/C/evolution-guide.sgml @@ -1,4 +1,5 @@ <!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[ + <!ENTITY PREFACE SYSTEM "preface.sgml"> <!ENTITY USAGE-MAINWINDOW SYSTEM "usage-mainwindow.sgml"> <!ENTITY USAGE-MAIL SYSTEM "usage-mail.sgml"> @@ -9,18 +10,18 @@ <!ENTITY CONFIG-SETUPASSIST SYSTEM "config-setupassist.sgml"> <!ENTITY CONFIG-PREFS SYSTEM "config-prefs.sgml"> <!ENTITY CONFIG-SYNC SYSTEM "config-sync.sgml"> -<!ENTITY APX-MENUREF SYSTEM "apx-menuref.sgml"> +<!ENTITY MENUREF SYSTEM "menuref.sgml"> <!ENTITY APX-GLOSS SYSTEM "apx-gloss.sgml"> <!ENTITY APX-BUGS SYSTEM "apx-bugs.sgml"> <!ENTITY APX-AUTHORS SYSTEM "apx-authors.sgml"> <!ENTITY APX-FDL SYSTEM "apx-fdl.sgml"> <!ENTITY APX-GPL SYSTEM "apx-gpl.sgml"> - ]> <!-- Almost every chapter is an entity. Files, Chapter id's, and entity names correspond. APX is for appendix. --> + <book id="index"> <bookinfo> <title>A User's Guide to Evolution</title> @@ -115,7 +116,18 @@ &CONFIG-SYNC; </part> - &APX-MENUREF; + <part> + <title>Comprehensive Menu reference</title> + <partintro> + <para> + The following reference covers all, or nearly all, of the + menus and menu commands that + <application>Evolution</application> has to offer you. + </para> + </partintro> + &MENUREF; + </part> + &APX-GLOSS; &APX-BUGS; &APX-AUTHORS; diff --git a/doc/C/apx-menuref.sgml b/doc/C/menuref.sgml index f47a921e31..b4ae8d4f83 100644 --- a/doc/C/apx-menuref.sgml +++ b/doc/C/menuref.sgml @@ -1,8 +1,8 @@ <!-- -<!DOCTYPE Appendix PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> +<!DOCTYPE Chapter PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> --> -<appendix id="menuref"> +<chapter id="menuref"> <title>Menu Reference</title> <para> This section will serve as a reference for every capability that @@ -559,6 +559,140 @@ </para> </sect2> </sect1> + <sect1 id="menuref-mail-context"> + <title>Contextual Menus in Evolution Mail</title> + <para> + The following menus appear when you right-click on something: + </para> + + <sect2 id="menuref-mail-context-message"> + <title>Right-click menu for messages in the message list</title> + <para> + <variablelist> + + <varlistentry> + <term><guimenuitem>Open in New Window</guimenuitem></term> + <listitem><para> + Open a new window to read this message. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Edit this Message</guimenuitem></term> + <listitem><para> + Available only for messages you have + written and saved to the <guilabel>Drafts</guilabel> + or <guilabel>Outbox</guilabel> folders, this opens the + message in a message composition window, so you can alter it. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Print</guimenuitem></term> + <listitem><para> + Opens the Print Preview window in preparation + for printing the message. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Reply to Sender</guimenuitem></term> + <listitem><para> + Opens a message composition window addressed to the + author of the message. Covered in detail in + <xref linkend="usage-mail-getnsend-send-reply">. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Reply to All</guimenuitem></term> + <listitem><para> + Opens a message composition window addressed to the + author of the message and all known recipients. + Covered in detail in <xref linkend="usage-mail-getnsend-send-reply">. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Forward</guimenuitem></term> + <listitem><para> + Appends the body of the selected message to a new message. + Covered in detail in <xref linkend="usage-mail-getnsend-fwd">. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Delete Message</guimenuitem></term> + <listitem><para> + Marks a message for deletion. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Move Message</guimenuitem></term> + <listitem><para> + Choose a folder in which to place this message. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>VFolder on Subject</guimenuitem></term> + <listitem><para> + This item, and the three that follow it, will create vFolders + which you may customize further or save as-is. This one will + create a vFolder which will display all messages that contain the + subject line of the selected message. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>VFolder on Sender</guimenuitem></term> + <listitem><para> + Creates a vFolder to hold all messages from the sender of + the selected message. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term><guimenuitem>VFolder on Recipients</guimenuitem></term> + <listitem><para> + Creates a VFolder to hold all messages addressed to the + recipient of the selected message. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Filter on Subject</guimenuitem></term> + <listitem><para> + This item, and the three that follow it, will create Filters + for which you must select actions. You may keep the criteria as + they are, or alter them as you wish. This one will + create a filter which will affect all messages that contain the + subject line of the selected message. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenuitem>Filter on Sender</guimenuitem></term> + <listitem><para> + Creates a Filter which affects all messages from the sender of + the selected message. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term><guimenuitem>Filter on Recipients</guimenuitem></term> + <listitem><para> + Creates a filter which will affect all messages addressed to the + recipient of the selected message. + </para></listitem> + </varlistentry> + </variablelist> + </para> + </sect2> + </sect1> <sect1 id="menuref-cal"> <title>The Calendar Menus</title> @@ -1052,7 +1186,7 @@ </sect1> -</appendix> +</chapter> diff --git a/doc/C/preface.sgml b/doc/C/preface.sgml index c7f6c2824d..f456be0e22 100644 --- a/doc/C/preface.sgml +++ b/doc/C/preface.sgml @@ -167,11 +167,11 @@ </formalpara> </sect1> <sect1 id="commontasks"> - <title>A Quick Reference to Common Tasks</title> + <title>Quick Reference for Common Tasks</title> <para> - You might want to copy the next few pages and tape them to the - wall next to your computer: They contain a very short run-down - of most of the things you'll want to do with + You might want to get a copy of this section and tape it to + the wall next to your computer: they contain a very short + run-down of most of the things you'll want to do with <application>Evolution</application>, and pointers to the sections of the book where you'll find more in-depth description of those tasks. @@ -305,7 +305,7 @@ </varlistentry> <varlistentry> - <term>Reply to Message</term> + <term>Reply to a message Message</term> <listitem> <para> Select the message to which you want to reply, and @@ -321,7 +321,7 @@ </varlistentry> <varlistentry> - <term>Forward Message</term> + <term>Forward a Message</term> <listitem> <para> Select the message you want to forward, and @@ -360,7 +360,6 @@ <title>Calendar</title> <para> - <variablelist> <varlistentry> <term></term> diff --git a/doc/C/usage-mail.sgml b/doc/C/usage-mail.sgml index ed101f6884..ad7419f330 100644 --- a/doc/C/usage-mail.sgml +++ b/doc/C/usage-mail.sgml @@ -48,6 +48,7 @@ <sect1 id="usage-mail-getnsend"> <title>Reading, Getting and Sending Mail</title> + <sect2 id="usage-mail-getnsend-read"> <title>Reading Mail</title> <para> @@ -55,161 +56,37 @@ <guibutton>Inbox</guibutton> in the shortcut bar. By default, the <interface>Inbox</interface> is open when you start <application>Evolution</application>, and the first - time you see your inbox, there's a message in it from Helix + time you see your Inbox, there's a message in it from Helix Code welcoming you to the application. </para> <para> - The first time you open your - <application>Evolution</application> - <guilabel>Inbox</guilabel>, you will see a window like the one - in <xref linkend="usage-mail-intro-fig">, with a message from - Helix Code in the <interface>message list</interface>. The - message is displayed below that, in the <interface>view - pane</interface>. If you find the <interface>view - pane</interface> too small, you can double-click on the - message in the <interface>message list</interface> to have it - open in a new window. As is the case with folders, you can - right-click on messages in the message list and get a menu of - possible actions: - <variablelist> - - <varlistentry> - <term><guimenuitem>Open in New Window</guimenuitem> </term> - <listitem><para> - Select this item to view the message in - a new <application>Evolution</application> - window. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Edit Message</guimenuitem></term> - <listitem><para> - This item is available only for messages and drafts - that you have written. Select it to open the message - composer and make changes to the message. - </para></listitem> - </varlistentry> + The <application>Evolution</application> + <guilabel>Inbox</guilabel>, should look like the one in <xref + linkend="usage-mail-intro-fig">, which has a message from + Helix Code. The message summary appears at the top, in the + <interface>message list</interface>. The message itself is + displayed below that, in the <interface>view pane</interface>. + If you find the <interface>view pane</interface> too small, + you can double-click on the message in the <interface>message + list</interface> to have it open in a new window. Just like + with folders, you can right-click on messages in the message + list and get a menu of possible actions. + </para> - <varlistentry> - <term><guimenuitem>Print Message</guimenuitem> </term> - <listitem><para> - Select this item to print a message. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Reply to Sender</guimenuitem></term> - <listitem><para> - Use this item to reply only to the author of the message. - </para></listitem> - </varlistentry> + <!-- ==============Figure=================================== --> + + <figure id="usage-mail-intro-fig"> + <title>Evolution Mail</title> + <screenshot> + <screeninfo>Inbox</screeninfo> + <graphic fileref="fig/mail-pic" format="png" srccredit="Aaron Weber"> + </graphic> + </screenshot> + </figure> +<!-- ==============End of Figure============================== --> - <varlistentry> - <term><guimenuitem>Reply to All</guimenuitem></term> - <listitem><para> - Send a reply to the author of the message - and to all others on the recipient list. See <xref - linkend="usage-mail-getnsend-send-reply"> for more information. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Forward Message</guimenuitem> </term> - <listitem><para> - Send the message on to another person. - See <xref linkend="usage-mail-getnsend-fwd"> for - information about how to use the Forward feature. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Delete Message</guimenuitem> </term> - <listitem><para> - Mark the message for deletion. Choose <menuchoice> - <guimenu>Actions</guimenu><guimenuitem>Expunge</guimenuitem> - </menuchoice> to delete marked messages permanently. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>Move Message</guimenuitem> </term> - <listitem><para> - Select this item to move the message to another folder. - This will open a dialog to let you choose the destination - from a folder tree. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>vFolder for Subject</guimenuitem></term> - <listitem><para> - Select this item to create a pre-fabricated vFolder based on - the current message's Subject line. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>vFolder for Sender</guimenuitem></term> - <listitem><para> - Select this item to create a pre-fabricated vFolder based on - who sent the current message. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>vFolder for Recipients</guimenuitem></term> - <listitem><para> - Select this item to create a pre-fabricated vFolder based on - who the recipients are. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>Filter for Subject</guimenuitem></term> - <listitem><para> - Select this item to create a pre-fabricated filter based on - the current message's Subject line. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>Filter for Sender</guimenuitem></term> - <listitem><para> - Select this item to create a pre-fabricated filter based on - who sent the current message. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>Filter for Recipients</guimenuitem></term> - <listitem><para> - Select this item to create a pre-fabricated filter based on - who the recipients are. - </para></listitem> - </varlistentry> - </variablelist> - </para> - - <note id="usage-mail-listorder"> - <title>The Order of the Message List</title> - <para> - You can also select the order in which messages appear in - that list. To sort by sender, subject, or date, click on the - bars with those labels at the top of the message list. If - you click twice, you'll sort them in reverse order. - </para> - <para> - Aside from sorting the messages, you can opt to have the - messages threaded. Select <menuchoice> - <guimenu>View</guimenu> <guimenuitem>Threaded Message - List</guimenuitem> </menuchoice> to turn the threaded view - on or off. If the option selected, - <application>Evolution</application> will attempt to - associate related messages by using the - <systemitem>References</systemitem>, - <systemitem>In-Reply-To</systemitem>, and - <systemitem>Subject</systemitem> message headers. Messages - which are related are then placed next to each other, so - that it's easier to follow the thread of a conversation from - message to message. - </para> - </note> <para> Other actions you can perform are listed, appropriately, in the <guimenu>Actions</guimenu> menu in the menu bar: @@ -249,6 +126,35 @@ </varlistentry> </variablelist> </para> + <sect3 id="usage-mail-listorder"> + <title>Sorting the message list</title> + <para> + You can also select the order in which messages appear in + that list. To sort by sender, subject, or date, click on the + bars with those labels at the top of the message list. If + you click twice, you'll sort them in reverse order. + </para> + <para> + Aside from sorting the messages, you can opt to have the + messages threaded. Select <menuchoice> + <guimenu>View</guimenu> <guimenuitem>Threaded Message + List</guimenuitem> </menuchoice> to turn the threaded view + on or off. If the option selected, + <application>Evolution</application> will attempt to + associate related messages by using the + <systemitem>References</systemitem>, + <systemitem>In-Reply-To</systemitem>, and + <systemitem>Subject</systemitem> message headers. Messages + which are related are then placed next to each other, so + that it's easier to follow the thread of a conversation from + message to message. + </para> + </sect3> + </sect2> + + <sect2 id="usage-mail-getnsend-get"> + <title>Checking Mail</title> + <para> Now that you've had a look around the <interface>Inbox</interface>, select the welcome message in @@ -263,22 +169,8 @@ marked as deleted. At some point in the future, this feature will change to something a little less counter-intuitive. </para> - <!-- ==============Figure=================================== --> - - <figure id="usage-mail-intro-fig"> - <title>Evolution Mail</title> - <screenshot> - <screeninfo>Inbox</screeninfo> - <graphic fileref="fig/mail-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure============================== --> - </sect2> - <sect2 id="usage-mail-getnsend-get"> - <title>Checking Mail</title> <para> To check your email, just click <guibutton>Get mail</guibutton> in the toolbar. If this is the first time @@ -620,18 +512,10 @@ with quoted materials and the relevant replies interspersed--> <term><guimenuitem>Find Regex</guimenuitem></term> <listitem> <para> - Regular expressions, often called "regex" for short, - are a powerful way of expressing complicated - statements using metacharacters or wildcard symbols. - For example, the statement - <userinput>fly*so[a|u]p</userinput> means "any - phrase beginning with 'fly' and ending in 'soup' or - 'soap'", so you'd find both "fly in my soup" and - "fly in my soap." There's not room here to go into - depth here, but if you want, have a look at the - documentation for the <command>grep</command> - command. - </para></listitem> + Perform a search for a <glossterm>regular + expression</glossterm>, or "regex." + </para> + </listitem> </varlistentry> <varlistentry> diff --git a/doc/C/usage-mainwindow.sgml b/doc/C/usage-mainwindow.sgml index 370403415d..3dcc38db86 100644 --- a/doc/C/usage-mainwindow.sgml +++ b/doc/C/usage-mainwindow.sgml @@ -302,7 +302,7 @@ <para> Any time new information arrives in a folder, that folder label - is displayed as bold text. + is displayed in bold text. </para> <para> To delete a folder, right-click it and select @@ -324,10 +324,8 @@ items will relate to mail; some will relate to other components of <application>Evolution</application> and some, especially those in the <guimenu>File Menu</guimenu> will relate to the - application as a whole. This section describes those items that - cover the application as a whole; items specific to mailer are - discussed in the mail chapter, calendar items in the calendar - chapter, and so forth. + application as a whole. The contents of the menu bar are + described in <xref linkend="menuref">. </para> <para> <variablelist> @@ -335,31 +333,11 @@ <term> <guimenu>File</guimenu> Menu</term> <listitem><para> - Anything related to a file falls under this - menu: - <itemizedlist> - <listitem><para> - <guisubmenu>New... — </guisubmenu> If you - want to create a new folder, calendar, - appointment, address card, or message, this is - where you should look. - </para></listitem> - - <listitem><para> - <guimenuitem>Go to Folder — </guimenuitem> - Select this item, then choose which folder you'd - like to view. - </para></listitem> - <listitem><para> - <guimenuitem>Exit — </guimenuitem> Quits the application. - </para></listitem> - - <listitem><para> - <guimenuitem>Print... — </guimenuitem> Opens the printing - dialog box so you can print items from the view pane of - <application>Evolution</application>. - </para></listitem> - </itemizedlist> + Anything even related to a file or to the operations + of the application generally falls under this + menu: creating things, saving them to disk, + printing them, and quitting the program itself. + </para></listitem> </varlistentry> @@ -368,7 +346,7 @@ <listitem><para> Although it doesn't contain anything at first, the <guimenu>Edit</guimenu> menu fills up with - useful editing tools when you're... editing. + useful tools that help you edit text and move it around. </para></listitem> </varlistentry> @@ -380,7 +358,8 @@ Configuration</guimenuitem> and the <guimenuitem>vFolder Editor</guimenuitem>. For the <interface>Calendar</interface> and the <interface>Contact - Manager</interface> </para></listitem> + Manager</interface>, it's color, network, and layout + configuration. </para></listitem> </varlistentry> <varlistentry> @@ -401,16 +380,17 @@ <term> <guimenu>Help</guimenu> Menu</term> <listitem><para> Select among these items to open the - <application>Help Browser</application> to the appropriate section. + <application>Help Browser</application> + and read the <application>Evolution</application> manual. </para></listitem> </varlistentry> </variablelist> </para> <para> Once you've familiarized yourself with the <interface>main - window</interface> you can start doing things with it. We'lql - start with your email inbox: you've got a letter waiting for you - already. + window</interface> you can start doing things with it. We'll + start with your email inbox, since you've got a letter waiting + for you already. </para> </sect1> </chapter> |