aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAaron Weber <aaron@helixcode.com>2000-08-31 14:02:03 +0800
committerAaron Weber <aaron@src.gnome.org>2000-08-31 14:02:03 +0800
commit04865e57d321a7d35e5165e8ec6de8f505ab54de (patch)
tree9f5020531091fd3b8475a962c34917dfdd890a6c /doc
parent2f478348f575be5846df82c4cedeac89e6eab31c (diff)
downloadgsoc2013-evolution-04865e57d321a7d35e5165e8ec6de8f505ab54de.tar
gsoc2013-evolution-04865e57d321a7d35e5165e8ec6de8f505ab54de.tar.gz
gsoc2013-evolution-04865e57d321a7d35e5165e8ec6de8f505ab54de.tar.bz2
gsoc2013-evolution-04865e57d321a7d35e5165e8ec6de8f505ab54de.tar.lz
gsoc2013-evolution-04865e57d321a7d35e5165e8ec6de8f505ab54de.tar.xz
gsoc2013-evolution-04865e57d321a7d35e5165e8ec6de8f505ab54de.tar.zst
gsoc2013-evolution-04865e57d321a7d35e5165e8ec6de8f505ab54de.zip
Added "quickref and pointers" sections. Props to O'Reilly for the copy of
2000-08-31 Aaron Weber <aaron@helixcode.com> * C/preface.sgml: Added "quickref and pointers" sections. Props to O'Reilly for the copy of Outlook in a Nutshell which gave me the idea. 2000-08-30 Aaron Weber <aaron@helixcode.com> * C/usage-mainwindow.sgml: Minor fixes. * C/preface.sgml: Corrected grammar, added glossterms, described menuref. svn path=/trunk/; revision=5136
Diffstat (limited to 'doc')
-rw-r--r--doc/C/.cvsignore5
-rw-r--r--doc/C/evolution-guide.sgml12
-rw-r--r--doc/C/preface.sgml285
-rw-r--r--doc/C/usage-mainwindow.sgml69
-rw-r--r--doc/ChangeLog13
5 files changed, 326 insertions, 58 deletions
diff --git a/doc/C/.cvsignore b/doc/C/.cvsignore
index cba1534920..2f4c48adbf 100644
--- a/doc/C/.cvsignore
+++ b/doc/C/.cvsignore
@@ -2,3 +2,8 @@ Makefile
Makefile.in
evolution-guide
evolution-guide.junk
+evolution-guide.log
+evolution-guide.ps
+evolution-guide.dvi
+evolution-guide.tex
+fig/*.eps \ No newline at end of file
diff --git a/doc/C/evolution-guide.sgml b/doc/C/evolution-guide.sgml
index b9b5f72adb..f7a7a87ab2 100644
--- a/doc/C/evolution-guide.sgml
+++ b/doc/C/evolution-guide.sgml
@@ -48,7 +48,7 @@
<citetitle>GNU General Public License</citetitle>, or GPL.
</para>
<para>
- The licenses are included with this document in <xref
+ These licenses are included with this document in <xref
linkend="fdl">, and <xref linkend="gpl">; you may also obtain
a copy from the Free Software Foundation by visiting <ulink
type="http" url="http://www.fsf.org">their Web site</ulink> or
@@ -102,11 +102,11 @@
<application>Evolution</application> is highly configurable.
Usually, when developers say that, they mean that they didn't
test it out thoroughly and have left it to other hackers to
- "configure" themselves a working system. When we say
- configurable, we mean that although
- <application>Evolution</application> will work perfectly well
- with minimal setup hassle, you can alter its behavior to fit
- your needs with just a little more work.
+ "configure" themselves a working system. But in the case of
+ <application>Evolution</application>, you can expect that it
+ will work perfectly well with minimal setup hassle, and that
+ you can alter its behavior to fit your needs with just a
+ little more work.
</para>
</partintro>
diff --git a/doc/C/preface.sgml b/doc/C/preface.sgml
index bb6cb4d948..c7f6c2824d 100644
--- a/doc/C/preface.sgml
+++ b/doc/C/preface.sgml
@@ -1,10 +1,13 @@
-<!-- <!DOCTYPE preface PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> -->
+<!--
+<!DOCTYPE preface PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN">
+-->
+
<preface id="introduction">
<!-- =============Introduction ============================= -->
<title>Introduction</title>
- <section id="what">
- <title> What is Evolution, and What Can It Do for Me?</title>
+ <sect1 id="what">
+ <title>What is Evolution, and What Can It Do for Me?</title>
<para>
The word "evolution" means "a process of improvement and
development." The GNOME application
@@ -17,8 +20,7 @@
<application>Evolution</application> is free software. The
program and its source code are released under the terms of
the GNU Public License (GPL), and the documentation falls
- under the Free Documentation License (FDL), which is included
- with this document (<xref linkend="fdl">). For more
+ under the Free Documentation License (FDL). For more
information about the GPL and the FDL, visit the Free Software
Foundation's website at <ulink
url="http://www.fsf.org">http://www.fsf.org</ulink>.
@@ -75,18 +77,17 @@
to turn <application>Evolution</application> into an
advanced development platform. From the simplest
scripting to the most complex network and component
- programming, <application>Evolution</application>
- needed to offer developers an environment for
- cutting-edge application development.
+ programming, <application>Evolution</application> must
+ to offer developers an environment for cutting-edge
+ application development.
</para>
</listitem>
<listitem>
<para>
Data must be safe: <application>Evolution</application>
- must not lose mail or corrupt mailbox files. It will
- not execute scripts, automatically forward a virus to
- your entire contacts list, or delete files from your
- hard disk.
+ must not not lose mail, corrupt mailbox files or other
+ data, execute arbitrary scripts, or delete files from
+ your hard disk.
</para>
</listitem>
</itemizedlist>
@@ -105,9 +106,9 @@
folders.
</para>
- </section>
+ </sect1>
- <section id="aboutbook">
+ <sect1 id="aboutbook">
<title>About This Book</title>
<!-- ************** FOLLOWING PARAGRAPH FOR DRAFT ONLY ************* -->
<para>
@@ -119,21 +120,26 @@
guide to <email>aaron@helixcode.com</email>. If you would like
to work on the guide please contact me or see the GNOME
Documentation project <ulink
- url="http://www.gnome.org/gdp">web site</ulink>. This
- paragraph will be removed in later versions of the manual.
+ url="http://developer.gnome.org/projects/gdp">web
+ site</ulink>. This paragraph will be removed in later
+ versions of the manual.
</para>
<!-- ************* END DRAFT ONLY PARAGRAPH ************** -->
<para>
- This book is divided into two sections. The first section is a
- <link linkend="usage">guided tour</link>&mdash; it will
- explain how to use <application>Evolution</application>. If
- you are new to <application>Evolution</application> or to
- groupware in general, this is the section for you. The second
- section, covering <link linkend="config">configuration</link>,
- is targeted at more advanced users, but anyone who wants to
+ This book is divided into two parts, with several
+ appendicies. The first part is a <link linkend="usage">guided
+ tour</link>&mdash; it will explain how to use
+ <application>Evolution</application>. If you are new to
+ <application>Evolution</application> or to groupware in
+ general, this is the section for you. The second section,
+ covering <link linkend="config">configuration</link>, is
+ targeted at more advanced users, but anyone who wants to
change the way <application>Evolution</application> looks or
- acts can benefit from reading it.
+ acts can benefit from reading it. In addition, there is a
+ comprehensive <link linkend="menuref">menu
+ reference</link> which describes nearly every capability that
+ <application>Evolution</application> has to offer.
</para>
<formalpara>
<title>Typographical conventions</title>
@@ -154,11 +160,238 @@
<member><guibutton>Buttons</guibutton> you can click</member>
<member><userinput>Anything you type in</userinput></member>
<member><computeroutput>Text output from a computer</computeroutput></member>
-
+ <member><glossterm>Words</glossterm> that are defined
+ in <xref linkend="apx-gloss">.</member>
</simplelist>
</para>
</formalpara>
- </section>
+ </sect1>
+ <sect1 id="commontasks">
+ <title>A Quick Reference to 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
+ <application>Evolution</application>, and pointers to the
+ sections of the book where you'll find more in-depth
+ description of those tasks.
+ </para>
+ <sect2 id="quickref-newthings">
+ <title>Opening or Creating Anything</title>
+ <para>
+ Here are the keyboard shortcuts and menu items you're most
+ likely to use: (Please note that the shortcuts listed are
+ probably wrong at this point).
+
+ <variablelist>
+
+ <varlistentry>
+ <term>Create a new folder</term>
+ <listitem>
+ <para>
+ <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu>
+ <guimenuitem>Folder</guimenuitem></menuchoice> or
+ <keycombo action="simul">
+ <keycap>Ctrl</keycap>
+ <keycap>Shift </keycap>
+ <keycap>F</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Create a new Shortcut in the Evolution Bar</term>
+ <listitem>
+ <para>
+ <menuchoice><guimenu>File</guimenu>
+ <guisubmenu>New</guisubmenu>
+ <guimenuitem>Evolution Bar Shortcut</guimenuitem> </menuchoice> or
+ <keycombo action="simul">
+ <keycap>Ctrl</keycap>
+ <keycap>Shift</keycap>
+ <keycap>S</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Create a new email message:</term>
+ <listitem>
+ <para>
+ Use
+ <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu><guimenuitem>Mail
+ Message</guimenuitem> </menuchoice> or
+ <keycombo action="simul">
+ <keycap>Ctrl</keycap>
+ <keycap>Shift </keycap>
+ <keycap>M</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Create a new Appointment</term>
+ <listitem>
+ <para>
+ <menuchoice><guimenu>File</guimenu>
+ <guisubmenu>New</guisubmenu>
+ <guimenuitem>Appointment</guimenuitem> </menuchoice> or
+ <keycombo action="simul">
+ <keycap>Ctrl</keycap>
+ <keycap>Shift</keycap>
+ <keycap>A</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Create a new Task</term>
+ <listitem>
+ <para>
+ <menuchoice><guimenu>File</guimenu>
+ <guisubmenu>New</guisubmenu>
+ <guimenuitem>Task</guimenuitem> </menuchoice> or
+ <keycombo action="simul">
+ <keycap>Ctrl</keycap>
+ <keycap>Shift</keycap>
+ <keycap>T</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term>Enter a new Contact</term>
+ <listitem>
+ <para>
+ <menuchoice><guimenu>File</guimenu>
+ <guisubmenu>New</guisubmenu>
+ <guimenuitem>Contact</guimenuitem> </menuchoice> or
+ <keycombo action="simul">
+ <keycap>Ctrl</keycap>
+ <keycap>Shift</keycap>
+ <keycap>C</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+
+ </variablelist>
+ </para>
+ </sect2>
+ <sect2 id="quickref-mail">
+ <title>Mail Tasks</title>
+ <para>
+ Here are the most frequent email tasks:
+ <variablelist>
+ <varlistentry>
+ <term>Check Mail</term>
+ <listitem>
+ <para>
+ Click <guibutton>Get Mail</guibutton> in the toolbar, or press
+ <keycombo action="simul">
+ <keycap>FIXME</keycap>
+ <keycap>FIXME</keycap>
+ <keycap>FIXME</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Reply to Message</term>
+ <listitem>
+ <para>
+ Select the message to which you want to reply, and
+ click Click <guibutton>Reply</guibutton> in the
+ toolbar, or press
+ <keycombo action="simul">
+ <keycap>FIXME</keycap>
+ <keycap>FIXME</keycap>
+ <keycap>FIXME</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Forward Message</term>
+ <listitem>
+ <para>
+ Select the message you want to forward, and
+ click Click <guibutton>Forward</guibutton> in the
+ toolbar, or press
+ <keycombo action="simul">
+ <keycap>FIXME</keycap>
+ <keycap>FIXME</keycap>
+ <keycap>FIXME</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Create Filters and vFolders</term>
+ <listitem>
+ <para>
+ You can create filters and vFolders based on specific
+ message attributes by right-clicking on a message or
+ by selecting <menuchoice> <guimenu>Tools</guimenu>
+ <guimenuitem>Mail Filters</guimenuitem> </menuchoice>
+ or <menuchoice> <guimenu>Tools</guimenu>
+ <guimenuitem>vFolder Editor</guimenuitem>
+ </menuchoice>. Filters are discussed in <xref
+ linkend="usage-mail-organize-filters">, and vFolders
+ in <xref linkend="usage-mail-organize-vfolders">.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </para>
+ </sect2>
+ <sect2 id="quickref-cal">
+ <title>Calendar</title>
+ <para>
+
+
+ <variablelist>
+ <varlistentry>
+ <term></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </para>
+ </sect2>
+ <sect2 id="quickref-contact">
+ <title>Contact Manager</title>
+ <para>
+
+
+ <variablelist>
+ <varlistentry>
+ <term></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+
+ </para>
+ </sect2>
+ </sect1>
</preface>
diff --git a/doc/C/usage-mainwindow.sgml b/doc/C/usage-mainwindow.sgml
index 8a71f2d4f2..370403415d 100644
--- a/doc/C/usage-mainwindow.sgml
+++ b/doc/C/usage-mainwindow.sgml
@@ -6,13 +6,14 @@
<title>The Main Window: Evolution Basics</title>
<para>
Start <application>Evolution</application> by selecting
- <guimenuitem>Evolution</guimenuitem> from the
- <guisubmenu>Applications</guisubmenu> of the <guimenu>Main Panel
- Menu</guimenu>, or by typing <command>evolution</command> at the
- command-line. The first time you run the program, it will create
- a directory called <filename>evolution</filename> in your home
- directory, where it will keep all your
- <application>Evolution</application>-related files.
+ <menuchoice><guimenu>Main Panel Menu</guimenu>
+ <guisubmenu>Applications</guisubmenu>
+ <guimenuitem>Evolution</guimenuitem></menuchoice> or by typing
+ <command>evolution</command> at the command line. The first time
+ you run the program, it will create a directory called
+ <filename>evolution</filename> in your home directory, where it
+ will keep all your <application>Evolution</application>-related
+ files.
</para>
<para>
After <application>Evolution</application> starts
@@ -88,7 +89,7 @@
</para>
<para>
Take a look at the <guilabel>Evolution Shortcuts</guilabel>
- again. They are:
+ again. The shortcut buttons in that category are:
<variablelist>
@@ -165,27 +166,40 @@
</variablelist>
</para>
<para>
- If you prefer to use a keyboard shortcut, or <glossterm>hot
- key</glossterm>, you can use those instead. They're shown next
- to their equivalent menu items in the menu bar. You can also set
- your own hot keys for functions that don't have any; this is
- covered in <xref linkend="config">. If you're using the
+ If you don't like the shortcut bar, you can use keyboard
+ shortcuts, or <glossterm>hot keys</glossterm>. They're shown
+ next to their equivalent menu items in the menu bar. You can
+ also set your own hot keys for functions that don't have any;
+ this is covered in <xref linkend="config">. If you're using the
keyboard shortcuts you may also want to hide the
- <interface>shortcut bar</interface> by selecting
- <menuchoice> <guimenu>View</guimenu> <guimenuitem>Show Shortcut
+ <interface>shortcut bar</interface> by selecting <menuchoice>
+ <guimenu>View</guimenu> <guimenuitem>Show Shortcut
Bar</guimenuitem> </menuchoice>.
</para>
<tip>
- <title>Two Shortcut Bar Tricks</title>
+ <title>Shortcut Bar Tricks</title>
<para>
To remove a shortcut from the shortcut bar, right-click on it
- and select <guimenuitem>Remove</guimenuitem>. </para>
+ and select <guimenuitem>Remove</guimenuitem>. To add one,
+ select <menuchoice> <guimenu>File</guimenu>
+ <guisubmenu>New</guisubmenu> <guimenuitem>Evolution Bar
+ Shortcut</guimenuitem> </menuchoice>. </para>
<para>
To change the way the shortcut bar looks, right-click in an
empoy space on the shortcut bar. From the menu that appears,
you can select icon sizes.
</para>
+ <para>
+ You don't need the folder bar to move between folders. You
+ can use <menuchoice> <guimenu>File</guimenu> <guimenuitem>Go
+ to Folder...</guimenuitem> </menuchoice> to move to a
+ particular foder. It's faster, however, to click on the
+ <guilabel>Inbox</guilabel> label just below the toolbar, to
+ the right of the shortcut bar, and select a folder from
+ there. The <guilabel>Inbox</guilabel> label will change to
+ reflect your location in the folder tree.
+ </para>
</tip>
</sect1>
@@ -200,18 +214,21 @@
at the top, and branches downwards. On most computers, there
will be three folders at the base. The first one is
<guilabel>VFolders</guilabel>, for virtual folders (discussed in
- <xref linkend="usage-mail-organize-vfolders">. The next one is
- <guilabel>External Directories</guilabel>, for contact
- directories stored on a network. The most important one is
- probably <guilabel>Local</guilabel>, which you can use to access
- all the data that's stored on your computer. If you click on
- the plus sign plus sign next to the <guilabel>Local</guilabel>
- folder, you'll see the contents:
+ <xref linkend="usage-mail-organize-vfolders">. After that come
+ any <glossterm>IMAP</glossterm> mail folders you might have
+ available to you over your network. The next folder is called
+ <guilabel>External Directories</guilabel>, and holds
+ <glossterm>LDAP</glossterm> contact directories stored on a
+ network. The most important one is probably
+ <guilabel>Local</guilabel>, which you can use to access all the
+ data that's stored on your computer. If you click on the plus
+ sign plus sign next to the <guilabel>Local</guilabel> folder,
+ you'll see the contents:
<itemizedlist>
<listitem>
<para>
- <guilabel>Calendar</guilabel>, for appointments and
- event listings.
+ <guilabel>Calendar</guilabel>, for appointments and
+ event listings.
</para>
</listitem>
<listitem>
diff --git a/doc/ChangeLog b/doc/ChangeLog
index fc9cdc0cf1..de7d5b808e 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,16 @@
+2000-08-31 Aaron Weber <aaron@helixcode.com>
+
+ * C/preface.sgml: Added "quickref and pointers" sections. Props to
+ O'Reilly for the copy of Outlook in a Nutshell which gave me the
+ idea.
+
+2000-08-30 Aaron Weber <aaron@helixcode.com>
+
+ * C/usage-mainwindow.sgml: Minor fixes.
+
+ * C/preface.sgml: Corrected grammar, added glossterms, described
+ menuref.
+
2000-08-25 Aaron Weber <aaron@helixcode.com>
* C/usage-mail.sgml: Redid filter and vFolder assistant