diff options
Diffstat (limited to 'doc')
27 files changed, 0 insertions, 4602 deletions
diff --git a/doc/.cvsignore b/doc/.cvsignore deleted file mode 100644 index 550bd25cdb..0000000000 --- a/doc/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile - diff --git a/doc/C/apx-authors.sgml b/doc/C/apx-authors.sgml deleted file mode 100644 index 7039f6c9c9..0000000000 --- a/doc/C/apx-authors.sgml +++ /dev/null @@ -1,70 +0,0 @@ - - <appendix id="authors"> - <title>Authors</title> - <para> - <application>Evolution</application> was written by: -<simplelist> - <member>Seth Alves: <email>alves@helixcode.com</email></member> - <member>Anders Carlsson<email>andersca@gnu.org</email></member> - <member>Damon Chaplin:<email>damon@helixcode.com</email></member> - <member>Clifford R. Conover <email>rusty@zootweb.com</email></member> - <member>Miguel De Icaza: <email>miguel@helixcode.com</email></member> - <member>Arturo Espinoza <email>arturo@nucleu.unam.mx</email></member> - <member>Larry Ewing: <email>lewing@helixcode.com</email></member> - <member>Bertrand Guiheneuf: <email>bertrand@helixcode.com</email></member> - <member>Tuomas Kuosmanen: <email>tigert@gimp.org</email></member> - <member>Christopher J. Lahey: <email>clahey@helixcode.com</email></member> - <member>Matthew Loper: <email>matt@helixcode.com</email></member> - <member>Dave Mason <email>dcm@redhat.com</email></member> - <member> Federico Mena: <email>federico@helixcode.com</email></member> - <member>Eskil Heyn Olsen<email>deity@eski.dk</email></member> - <member> Nat Friedman: <email>nat@helixcode.com</email></member> - <member>Ettore Perazzoli:<email>ettore@helixcode.com</email></member> - <member>Russell Steinthal: <email>rms39@columbia.edu</email></member> - <member> Peter Teichman: <email>peter@helixcode.com</email></member> - <member> Chris Toshok: <email>toshok@helixcode.com</email></member> - <member> Radek Doulik: <email>rodo@helixcode.com</email></member> - <member> Dan Winship: <email>winship@helixcode.com</email></member> - <member> Michael Zucchi: <email>notzed@helixcode.com</email></member> -</simplelist> -and other dedicated GNOME programmers. -</para> - <para> - The <application>Evolution</application> code owes a great debt - to the <application>GNOME-pim</application> and - <application>GNOME-Calendar</application> applications, and to - <application>KHTMLW</application>. The developers of - <application>Evolution</application> acknowledge the efforts - and contributions of all who worked on those projects. - </para> - - <para> - For more information please visit the - <application>Evolution</application> <ulink - url="http://www.helixcode.com/apps/evolution.php3" - type="http">Web page</ulink>. Please send all comments, - suggestions, and bug reports to the <ulink - url="http://bugs.gnome.org" type="http">GNOME bug tracking - database</ulink>. Instructions for submitting bug reports can be - found on-line at <ulink - url="http://bugs.gnome.org/Reporting.html" type="http"> - http://bugs.gnome.org/Reporting.html</ulink>. If you are using - GNOME 1.1 or later, you can also use command - <command>bug-buddy</command> for submitting bug reports. - </para> - <para> - This manual was written by Aaron Weber - (<email>aaron@helixcode.com</email>) with the help of the - application programmers and the GNOME Documentation Project. - Please send all comments and suggestions regarding the manual to - the GNOME Documentation Project at - <email>docs@gnome.org</email>. You can also add your comments - online by using <ulink type="http" - url="http://www.gnome.org/gdp/doctable/">GNOME Documentation - Status Table</ulink>. - </para> - <!-- For translations: uncomment this: <para> Latin translation - was done by ME (<email>MYNAME@MYADDRESS</email>). Please send - all comments and suggestions regarding this translation to - SOMEWHERE. </para> --> - </appendix> diff --git a/doc/C/apx-bugs.sgml b/doc/C/apx-bugs.sgml deleted file mode 100644 index eb30901422..0000000000 --- a/doc/C/apx-bugs.sgml +++ /dev/null @@ -1,19 +0,0 @@ - <appendix id="bugs"> - - <title>Known bugs and limitations</title> - <abstract> - <para> - This appendix describes known bugs and limitations of - <application>Evolution</application>. Please contact the - Evolution team (<email>bugs@helixcode.com</email>) or use - <application>bug-buddy</application> if you find one we have not - listed, or if you have a patch to fix one. - </para> - </abstract> - - <para> - The bugs are many, but the application is young, and this is to - be expected. - </para> - </appendix> - diff --git a/doc/C/apx-fdl.sgml b/doc/C/apx-fdl.sgml deleted file mode 100644 index 7a85c6e4a2..0000000000 --- a/doc/C/apx-fdl.sgml +++ /dev/null @@ -1,678 +0,0 @@ -<appendix id="fdl" label="Appendix - C"> - <title>GNU Free Documentation License</title> - <para> - Version 1.1, March 2000 - </para> - - <para> - Copyright © 2000 - <address> - Free Software Foundation, Inc. - <street>59 Temple Place, Suite 330</street>, - <city>Boston</city>, - <state>MA</state> - <postcode>02111-1307</postcode> - <country>USA</country> - </address> - Everyone is permitted to copy and distribute verbatim copies of this license - document, but changing it is not allowed. - </para> - - <variablelist> - <varlistentry id="fdl-preamble"> - <term>0. PREAMBLE</term> - <listitem> - <para> - The purpose of this License is to make a manual, textbook, or other - written document "free" in the sense of freedom: to assure everyone - the effective freedom to copy and redistribute it, with or without - modifying it, either commercially or noncommercially. Secondarily, - this License preserves for the author and publisher a way to get - credit for their work, while not being considered responsible for - modifications made by others. - </para> - - <para> - This License is a kind of "copyleft", which means that derivative - works of the document must themselves be free in the same sense. It - complements the GNU General Public License, which is a copyleft - license designed for free software. - </para> - - <para> - We have designed this License in order to use it for manuals for free - software, because free software needs free documentation: a free - program should come with manuals providing the same freedoms that the - software does. But this License is not limited to software manuals; it - can be used for any textual work, regardless of subject matter or - whether it is published as a printed book. We recommend this License - principally for works whose purpose is instruction or reference. - </para> - </listitem> - </varlistentry> - <varlistentry id="fdl-section1"> - <term>1. APPLICABILITY AND DEFINITIONS</term> - <listitem> - <para id="fdl-document"> - This License applies to any manual or other work that contains a - notice placed by the copyright holder saying it can be distributed - under the terms of this License. The <link - linkend="fdl-document">"Document" </link>, below, refers to any such - manual or work. Any member of the public is a licensee, and is - addressed as "you". - </para> - - <para id="fdl-modified"> - A <link linkend="fdl-modified">"Modified Version"</link> of the - Document means any work containing the Document or a portion of it, - either copied verbatim, or with modifications and/or translated into - another language. - </para> - - <para id="fdl-secondary"> - A <link linkend="fdl-secondary">"Secondary Section"</link> is a named - appendix or a front-matter section of the <link - linkend="fdl-document">Document</link> that deals exclusively with the - relationship of the publishers or authors of the <link - linkend="fdl-document"> Document</link> to the <link - linkend="fdl-document"> Document's</link> overall subject (or to - related matters) and contains nothing that could fall directly within - that overall subject. (For example, if the <link - linkend="fdl-document">Document</link> is in part a textbook of - mathematics, a <link linkend="fdl-secondary">Secondary Section</link> - may not explain any mathematics.) The relationship could be a matter - of historical connection with the subject or with related matters, or - of legal, commercial, philosophical, ethical or political position - regarding them. - </para> - - <para id="fdl-invariant"> - The <link linkend="fdl-invariant">"Invariant Sections"</link> are - certain <link linkend="fdl-secondary"> Secondary Sections</link> whose - titles are designated, as being those of <link - linkend="fdl-invariant">Invariant Sections</link>, in the notice that - says that the <link linkend="fdl-document">Document</link> is released - under this License. - </para> - - <para id="fdl-cover-texts"> - The <link linkend="fdl-cover-texts">"Cover Texts"</link> are certain - short passages of text that are listed, as <link - linkend="fdl-cover-texts">Front-Cover Texts</link> or <link - linkend="fdl-cover-texts">Back-Cover Texts</link>, in the notice that - says that the <link linkend="fdl-document">Document</link> is released - under this License. - </para> - - <para id="fdl-transparent"> - A <link linkend="fdl-transparent">"Transparent"</link> copy of the - <link linkend="fdl-document"> Document</link> means a machine-readable - copy, represented in a format whose specification is available to the - general public, whose contents can be viewed and edited directly and - straightforwardly with generic text editors or (for images composed of - pixels) generic paint programs or (for drawings) some widely available - drawing editor, and that is suitable for input to text formatters or - for automatic translation to a variety of formats suitable for input - to text formatters. A copy made in an otherwise <link - linkend="fdl-transparent"> Transparent</link> file format whose markup - has been designed to thwart or discourage subsequent modification by - readers is not <link linkend="fdl-transparent">Transparent</link>. A - copy that is not <link linkend="fdl-transparent">"Transparent"</link> - is called "Opaque". - </para> - - <para> - Examples of suitable formats for <link - linkend="fdl-transparent">Transparent</link> copies include plain - ASCII without markup, Texinfo input format, LaTeX input format, SGML - or XML using a publicly available DTD, and standard-conforming simple - HTML designed for human modification. Opaque formats include - PostScript, PDF, proprietary formats that can be read and edited only - by proprietary word processors, SGML or XML for which the DTD and/or - processing tools are not generally available, and the - machine-generated HTML produced by some word processors for output - purposes only. - </para> - - <para id="fdl-title-page"> - The <link linkend="fdl-title-page">"Title Page"</link> means, for a - printed book, the title page itself, plus such following pages as are - needed to hold, legibly, the material this License requires to appear - in the title page. For works in formats which do not have any title - page as such, <link linkend="fdl-title-page"> "Title Page"</link> - means the text near the most prominent appearance of the work's title, - preceding the beginning of the body of the text. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section2"> - <term>2. VERBATIM COPYING</term> - <listitem> - <para> - You may copy and distribute the <link - linkend="fdl-document">Document</link> in any medium, either - commercially or noncommercially, provided that this License, the - copyright notices, and the license notice saying this License applies - to the <link linkend="fdl-document">Document</link> are reproduced in - all copies, and that you add no other conditions whatsoever to those - of this License. You may not use technical measures to obstruct or - control the reading or further copying of the copies you make or - distribute. However, you may accept compensation in exchange for - copies. If you distribute a large enough number of copies you must - also follow the conditions in <link linkend="fdl-section3">section - 3</link>. - </para> - - <para> - You may also lend copies, under the same conditions stated above, and - you may publicly display copies. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section3"> - <term>3. COPYING IN QUANTITY</term> - <listitem> - <para> - If you publish printed copies of the <link - linkend="fdl-document">Document</link> numbering more than 100, and - the <link linkend="fdl-document">Document's</link> license notice - requires <link linkend="fdl-cover-texts">Cover Texts</link>, you must - enclose the copies in covers that carry, clearly and legibly, all - these <link linkend="fdl-cover-texts">Cover Texts</link>: Front-Cover - Texts on the front cover, and Back-Cover Texts on the back cover. Both - covers must also clearly and legibly identify you as the publisher of - these copies. The front cover must present the full title with all - words of the title equally prominent and visible. You may add other - material on the covers in addition. Copying with changes limited to - the covers, as long as they preserve the title of the <link - linkend="fdl-document">Document</link> and satisfy these conditions, - can be treated as verbatim copying in other respects. - </para> - - <para> - If the required texts for either cover are too voluminous to fit - legibly, you should put the first ones listed (as many as fit - reasonably) on the actual cover, and continue the rest onto adjacent - pages. - </para> - - <para> - If you publish or distribute <link - linkend="fdl-transparent">Opaque</link> copies of the <link - linkend="fdl-document">Document</link> numbering more than 100, you - must either include a machine-readable <link - linkend="fdl-transparent">Transparent</link> copy along with each - <link linkend="fdl-transparent">Opaque</link> copy, or state in or - with each <link linkend="fdl-transparent">Opaque</link> copy a - publicly-accessible computer-network location containing a complete - <link linkend="fdl-transparent"> Transparent</link> copy of the <link - linkend="fdl-document">Document</link>, free of added material, which - the general network-using public has access to download anonymously at - no charge using public-standard network protocols. If you use the - latter option, you must take reasonably prudent steps, when you begin - distribution of <link linkend="fdl-transparent">Opaque</link> copies - in quantity, to ensure that this <link - linkend="fdl-transparent">Transparent</link> copy will remain thus - accessible at the stated location until at least one year after the - last time you distribute an <link - linkend="fdl-transparent">Opaque</link> copy (directly or through your - agents or retailers) of that edition to the public. - </para> - - <para> - It is requested, but not required, that you contact the authors of the - <link linkend="fdl-document">Document</link> well before - redistributing any large number of copies, to give them a chance to - provide you with an updated version of the <link - linkend="fdl-document">Document</link>. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section4"> - <term>4. MODIFICATIONS</term> - <listitem> - <para> - You may copy and distribute a <link linkend="fdl-modified">Modified - Version</link> of the <link linkend="fdl-document">Document</link> - under the conditions of sections <link linkend="fdl-section2">2</link> - and <link linkend="fdl-section3">3</link> above, provided that you - release the <link linkend="fdl-modified">Modified Version</link> under - precisely this License, with the <link linkend="fdl-modified">Modified - Version</link> filling the role of the <link - linkend="fdl-document">Document</link>, thus licensing distribution - and modification of the <link linkend="fdl-modified">Modified - Version</link> to whoever possesses a copy of it. In addition, you - must do these things in the <link linkend="fdl-modified">Modified - Version</link>: - </para> - - <itemizedlist mark="opencircle"> - <listitem> - <formalpara> - <title>A</title> - <para> - Use in the <link linkend="fdl-title-page">Title Page</link> (and - on the covers, if any) a title distinct from that of the <link - linkend="fdl-document">Document</link>, and from those of - previous versions (which should, if there were any, be listed in - the History section of the <link - linkend="fdl-document">Document</link>). You may use the same - title as a previous version if the original publisher of that - version gives permission. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>B</title> - <para> - List on the <link linkend="fdl-title-page">Title Page</link>, as - authors, one or more persons or entities responsible for - authorship of the modifications in the <link - linkend="fdl-modified">Modified Version</link>, together with at - least five of the principal authors of the <link - linkend="fdl-document">Document</link> (all of its principal - authors, if it has less than five). - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>C</title> - <para> - State on the <link linkend="fdl-title-page">Title Page</link> - the name of the publisher of the <link - linkend="fdl-modified">Modified Version</link>, as the - publisher. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>D</title> - <para> - Preserve all the copyright notices of the <link - linkend="fdl-document">Document</link>. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>E</title> - <para> - Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>F</title> - <para> - Include, immediately after the copyright notices, a license - notice giving the public permission to use the <link - linkend="fdl-modified">Modified Version</link> under the terms - of this License, in the form shown in the Addendum below. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>G</title> - <para> - Preserve in that license notice the full lists of <link - linkend="fdl-invariant"> Invariant Sections</link> and required - <link linkend="fdl-cover-texts">Cover Texts</link> given in the - <link linkend="fdl-document">Document's</link> license notice. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>H</title> - <para> - Include an unaltered copy of this License. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>I</title> - <para> - Preserve the section entitled "History", and its title, and add - to it an item stating at least the title, year, new authors, and - publisher of the <link linkend="fdl-modified">Modified Version - </link>as given on the <link linkend="fdl-title-page">Title - Page</link>. If there is no section entitled "History" in the - <link linkend="fdl-document">Document</link>, create one stating - the title, year, authors, and publisher of the <link - linkend="fdl-document">Document</link> as given on its <link - linkend="fdl-title-page">Title Page</link>, then add an item - describing the <link linkend="fdl-modified">Modified - Version</link> as stated in the previous sentence. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>J</title> - <para> - Preserve the network location, if any, given in the <link - linkend="fdl-document">Document</link> for public access to a - <link linkend="fdl-transparent">Transparent</link> copy of the - <link linkend="fdl-document">Document</link>, and likewise the - network locations given in the <link - linkend="fdl-document">Document</link> for previous versions it - was based on. These may be placed in the "History" section. You - may omit a network location for a work that was published at - least four years before the <link - linkend="fdl-document">Document</link> itself, or if the - original publisher of the version it refers to gives permission. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>K</title> - <para> - In any section entitled "Acknowledgements" or "Dedications", - preserve the section's title, and preserve in the section all - the substance and tone of each of the contributor - acknowledgements and/or dedications given therein. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>L</title> - <para> - Preserve all the <link linkend="fdl-invariant">Invariant - Sections</link> of the <link - linkend="fdl-document">Document</link>, unaltered in their text - and in their titles. Section numbers or the equivalent are not - considered part of the section titles. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>M</title> - <para> - Delete any section entitled "Endorsements". Such a section may - not be included in the <link linkend="fdl-modified">Modified - Version</link>. - </para> - </formalpara> - </listitem> - - <listitem> - <formalpara> - <title>N</title> - <para> - Do not retitle any existing section as "Endorsements" or to - conflict in title with any <link - linkend="fdl-invariant">Invariant Section</link>. - </para> - </formalpara> - </listitem> - </itemizedlist> - - <para> - If the <link linkend="fdl-modified">Modified Version</link> includes - new front-matter sections or appendices that qualify as <link - linkend="fdl-secondary">Secondary Sections</link> and contain no - material copied from the Document, you may at your option designate - some or all of these sections as invariant. To do this, add their - titles to the list of <link linkend="fdl-invariant">Invariant - Sections</link> in the <link linkend="fdl-modified">Modified - Version's</link> license notice. These titles must be distinct from - any other section titles. - </para> - - <para> - You may add a section entitled "Endorsements", provided it contains - nothing but endorsements of your <link linkend="fdl-modified">Modified - Version</link> by various parties--for example, statements of peer - review or that the text has been approved by an organization as the - authoritative definition of a standard. - </para> - - <para> - You may add a passage of up to five words as a <link - linkend="fdl-cover-texts">Front-Cover Text</link>, and a passage of up - to 25 words as a <link linkend="fdl-cover-texts">Back-Cover - Text</link>, to the end of the list of <link - linkend="fdl-cover-texts">Cover Texts</link> in the <link - linkend="fdl-modified">Modified Version</link>. Only one passage of - <link linkend="fdl-cover-texts">Front-Cover Text</link> and one of - <link linkend="fdl-cover-texts">Back-Cover Text</link> may be added by - (or through arrangements made by) any one entity. If the <link - linkend="fdl-document">Document</link> already includes a cover text - for the same cover, previously added by you or by arrangement made by - the same entity you are acting on behalf of, you may not add another; - but you may replace the old one, on explicit permission from the - previous publisher that added the old one. - </para> - - <para> - The author(s) and publisher(s) of the <link - linkend="fdl-document">Document</link> do not by this License give - permission to use their names for publicity for or to assert or imply - endorsement of any <link linkend="fdl-modified">Modified Version - </link>. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section5"> - <term>5. COMBINING DOCUMENTS</term> - <listitem> - <para> - You may combine the <link linkend="fdl-document">Document</link> with - other documents released under this License, under the terms defined - in <link linkend="fdl-section4">section 4</link> above for modified - versions, provided that you include in the combination all of the - <link linkend="fdl-invariant">Invariant Sections</link> of all of the - original documents, unmodified, and list them all as <link - linkend="fdl-invariant">Invariant Sections</link> of your combined - work in its license notice. - </para> - - <para> - The combined work need only contain one copy of this License, and - multiple identical <link linkend="fdl-invariant">Invariant - Sections</link> may be replaced with a single copy. If there are - multiple <link linkend="fdl-invariant"> Invariant Sections</link> with - the same name but different contents, make the title of each such - section unique by adding at the end of it, in parentheses, the name of - the original author or publisher of that section if known, or else a - unique number. Make the same adjustment to the section titles in the - list of <link linkend="fdl-invariant">Invariant Sections</link> in the - license notice of the combined work. - </para> - - <para> - In the combination, you must combine any sections entitled "History" - in the various original documents, forming one section entitled - "History"; likewise combine any sections entitled "Acknowledgements", - and any sections entitled "Dedications". You must delete all sections - entitled "Endorsements." - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section6"> - <term>6. COLLECTIONS OF DOCUMENTS</term> - <listitem> - <para> - You may make a collection consisting of the <link - linkend="fdl-document">Document</link> and other documents released - under this License, and replace the individual copies of this License - in the various documents with a single copy that is included in the - collection, provided that you follow the rules of this License for - verbatim copying of each of the documents in all other respects. - </para> - - <para> - You may extract a single document from such a collection, and - distribute it individually under this License, provided you insert a - copy of this License into the extracted document, and follow this - License in all other respects regarding verbatim copying of that - document. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section7"> - <term>7. AGGREGATION WITH INDEPENDENT WORKS</term> - <listitem> - <para> - A compilation of the <link linkend="fdl-document">Document</link> or - its derivatives with other separate and independent documents or - works, in or on a volume of a storage or distribution medium, does not - as a whole count as a <link linkend="fdl-modified">Modified - Version</link> of the <link linkend="fdl-document"> Document</link>, - provided no compilation copyright is claimed for the compilation. - Such a compilation is called an "aggregate", and this License does not - apply to the other self-contained works thus compiled with the <link - linkend="fdl-document">Document</link> , on account of their being - thus compiled, if they are not themselves derivative works of the - <link linkend="fdl-document">Document</link>. If the <link - linkend="fdl-cover-texts">Cover Text</link> requirement of <link - linkend="fdl-section3">section 3</link> is applicable to these copies - of the <link linkend="fdl-document">Document</link>, then if the <link - linkend="fdl-document">Document</link> is less than one quarter of the - entire aggregate, the <link linkend="fdl-document">Document's</link> - <link linkend="fdl-cover-texts">Cover Texts</link> may be placed on - covers that surround only the <link - linkend="fdl-document">Document</link> within the aggregate. Otherwise - they must appear on covers around the whole aggregate. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section8"> - <term>8. TRANSLATION</term> - <listitem> - <para> - Translation is considered a kind of modification, so you may - distribute translations of the <link - linkend="fdl-document">Document</link> under the terms of <link - linkend="fdl-section4">section 4</link>. Replacing <link - linkend="fdl-invariant"> Invariant Sections</link> with translations - requires special permission from their copyright holders, but you may - include translations of some or all <link - linkend="fdl-invariant">Invariant Sections</link> in addition to the - original versions of these <link linkend="fdl-invariant">Invariant - Sections</link>. You may include a translation of this License - provided that you also include the original English version of this - License. In case of a disagreement between the translation and the - original English version of this License, the original English version - will prevail. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section9"> - <term>9. TERMINATION</term> - <listitem> - <para> - You may not copy, modify, sublicense, or distribute the <link - linkend="fdl-document">Document</link> except as expressly provided - for under this License. Any other attempt to copy, modify, sublicense - or distribute the <link linkend="fdl-document">Document</link> is - void, and will automatically terminate your rights under this - License. However, parties who have received copies, or rights, from - you under this License will not have their licenses terminated so long - as such parties remain in full compliance. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-section10"> - <term>10. FUTURE REVISIONS OF THIS LICENSE</term> - <listitem> - <para> - The <ulink type="http" url="http://www.gnu.org/fsf/fsf.html">Free - Software Foundation</ulink> may publish new, revised versions of the - GNU Free Documentation License from time to time. Such new versions - will be similar in spirit to the present version, but may differ in - detail to address new problems or concerns. See <ulink type="http" - url="http://www.gnu.org/copyleft">http://www.gnu.org/copyleft/</ulink>. - </para> - - <para> - Each version of the License is given a distinguishing version - number. If the <link linkend="fdl-document">Document</link> specifies - that a particular numbered version of this License "or any later - version" applies to it, you have the option of following the terms and - conditions either of that specified version or of any later version - that has been published (not as a draft) by the Free Software - Foundation. If the <link linkend="fdl-document">Document</link> does - not specify a version number of this License, you may choose any - version ever published (not as a draft) by the Free Software - Foundation. - </para> - </listitem> - </varlistentry> - - <varlistentry id="fdl-using"> - <term>Addendum</term> - <listitem> - <para> - To use this License in a document you have written, include a copy of - the License in the document and put the following copyright and - license notices just after the title page: - </para> - - <para> - Copyright © YEAR YOUR NAME. - </para> - - <para> - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 or - any later version published by the Free Software Foundation; with the - <link linkend="fdl-invariant">Invariant Sections</link> being LIST - THEIR TITLES, with the <link linkend="fdl-cover-texts">Front-Cover - Texts</link> being LIST, and with the <link - linkend="fdl-cover-texts">Back-Cover Texts</link> being LIST. A copy - of the license is included in the section entitled <quote>GNU Free - Documentation License</quote>. - </para> - - <para> - If you have no <link linkend="fdl-invariant">Invariant - Sections</link>, write "with no Invariant Sections" instead of saying - which ones are invariant. If you have no <link - linkend="fdl-cover-texts">Front-Cover Texts</link>, write "no - Front-Cover Texts" instead of "Front-Cover Texts being LIST"; likewise - for <link linkend="fdl-cover-texts">Back-Cover Texts</link>. - </para> - - <para> - If your document contains nontrivial examples of program code, we - recommend releasing these examples in parallel under your choice of - free software license, such as the <ulink type="http" - url="http://www.gnu.org/copyleft/gpl.html"> GNU General Public - License</ulink>, to permit their use in free software. - </para> - </listitem> - </varlistentry> - </variablelist> -</appendix>
\ No newline at end of file diff --git a/doc/C/apx-gloss.sgml b/doc/C/apx-gloss.sgml deleted file mode 100644 index 80f9b3f14b..0000000000 --- a/doc/C/apx-gloss.sgml +++ /dev/null @@ -1,242 +0,0 @@ - - -<glossary id="glossary"> - - <title>Glossary</title> - - <glossentry id="attachment"> - <glossterm>Attachment</glossterm> - <glossdef> - <para> - Any file sent with an e-mail for the reciever to download. - </para> - </glossdef> - </glossentry> - -<glossentry id="automatic-indexing"> - <glossterm>Automatic Indexing</glossterm> - <glossdef> - <para> - Pre-sorting procedure that allows - <application>Evolution</application> to refer to data quickly. - It enables faster searches and decreases memory usage for - data displays. - </para> - </glossdef> - </glossentry> - - <glossentry id="bcc"> - <glossterm>Bcc (Blind Carbon Copy)</glossterm> - <glossdef> - <para> - A way of addressing a message. Bcc is used to send a group of - people an e-mail, while hiding their names and addresses from each - other. - </para> - </glossdef> - </glossentry> - - <glossentry id="cc"> - <glossterm>Cc (Carbon Copy)</glossterm> - <glossdef> - <para> - Carbon-copies are used to send a 3rd party a copy of the e-mail, - so they an keep up to date on a conversation, without being in the - To: list. - </para> - </glossdef> - </glossentry> - - <glossentry id="druid"> - <glossterm>Druid</glossterm> - <glossdef> - <para> - A small program or script used to help configure or set up some - larger program. The <application>mail setup druid</application> - helps you ready your email system for use. Druids are the Linux - equivalent of "Assistants" and "Wizards." - </para> - </glossdef> - </glossentry> - - <glossentry id="evolution"> - <glossterm>Evolution</glossterm> - <glossdef> - <para> - <application>Evolution</application> is the <acronym> GNOME - </acronym> groupware application. - </para> - </glossdef> - </glossentry> - - <glossentry id="execute"> - <glossterm>Execute</glossterm> - <glossdef> - <para> - To run a program. Any file that can be run is called an - executable. In order to be execute program, a user must have - the proper permissions. - </para> - </glossdef> - </glossentry> - - <glossentry id="filter"> - <glossterm>Filter</glossterm> - <glossdef> - <para> - Within <application>Evolution</application>, a filter is a method - of sorting mail automatically. - </para> - </glossdef> - </glossentry> - - <glossentry id="forward"> - <glossterm>Forward</glossterm> - <glossdef> - <para> - By forwarding an e-mail, the user can send a third party a message - which was sent to the user originally. - </para> - </glossdef> - </glossentry> - - <glossentry id="groupware"> - <glossterm>Groupware</glossterm> - <glossdef> - <para> - Groupware is a term describing an application who has many - productivity features built into one program. - </para> - </glossdef> - </glossentry> - - <glossentry id="haiku"> - <glossterm>Haiku</glossterm> - <glossdef> - <para> - A Japanese form of poetry. Haiku are unrhymed, and - three lines long. The first and last lines should have five - syllables, and the second line seven syllables. The subject - matter is traditionally related to the seasons. - </para> - </glossdef> - </glossentry> - - <glossentry id="html"> - <glossterm>HTML</glossterm> - <glossdef> - <para> - Hyper-text Markup Language(<acronym>HTML</acronym>) is the layout - language which all webpages are written in. HTML can be used - inside of e-mails to insert images, justfiy text different ways, - and even include webpages inside the e-mail itself. - </para> - </glossdef> - </glossentry> - - <glossentry id="hot-key"> - <glossterm>Hot Key</glossterm> - <glossdef> - <para> - Hot-keys are keyboard combinations used to do actions on a - computer instead of using the mouse to do the same action. - Hot-keys can speed up computer usage. - </para> - </glossdef> - </glossentry> - - <glossentry id="ical"> - <glossterm>iCal</glossterm> - <glossdef> - <para> - <application>iCal</application> is the program which - <application>Evolution</application> uses to manage the calendar - section. - </para> - </glossdef> - </glossentry> - - <glossentry id="live-doc"> - <glossterm>Live Document</glossterm> - <glossdef> - <para> - A document embedded in or attached an email message that - contains scripting or other active contents. For example, a - <application>Gnumeric</application> spreadsheet page could be - included in a message, and the recipient could alter some of the - data from within <application>Evolution</application> without - having to start another program. - </para> - </glossdef> - </glossentry> - - <glossentry id="mail-client"> - <glossterm>Mail Client</glossterm> - <glossdef> - <para> - A mail client is the application which a user reads and sends - their e-mail with. - </para> - </glossdef> - </glossentry> - - <glossentry id="nautilus"> - <glossterm>Nautilus</glossterm> - <glossdef> - <para> - <application>Nautilus</application> is the next generation file - manager for <acronym>GNOME</acronym> being written by Eazel. - </para> - </glossdef> - </glossentry> - - <glossentry id="nickname"> - <glossterm>Nickname</glossterm> - <glossdef> - <para> - An alias for an e-mail address. - </para> - </glossdef> - </glossentry> - - <glossentry id="script"> - <glossterm>Script</glossterm> - <glossdef> - <para> - A program which is written in an interpreted language, which can - be executed. - </para> - </glossdef> - </glossentry> - - <glossentry id="shortcut-bar"> - <glossterm>Shortcut Bar</glossterm> - <glossdef> - <para> - The <interface>Shortcut Bar</interface> is where the user accesses - all the components of <application>Evolution</application> from. - </para> - </glossdef> - </glossentry> - - <glossentry id="spam"> - <glossterm>Spam</glossterm> - <glossdef> - <para> - Spam: useless e-mail. Spam normally comes in forms of - chain-letters and advertisements for websites or services. - </para> - </glossdef> - </glossentry> - - <glossentry id="vfolder"> - <glossterm>vFolder</glossterm> - <glossdef> - <para> - vFolders allow an e-mail to be shared among multiple folders, so - it appears that theres a copy of the e-mail in each folder. - </para> - </glossdef> - </glossentry> - -</glossary> diff --git a/doc/C/config-prefs.sgml b/doc/C/config-prefs.sgml deleted file mode 100644 index 8ca4dbbc7d..0000000000 --- a/doc/C/config-prefs.sgml +++ /dev/null @@ -1,202 +0,0 @@ - - <chapter id="config-prefs"> - <title>Advanced Configuration with the Preferences Window</title> - <para> - To change your configuration settings, select - <guimenuitem>Preferences</guimenuitem> from the - <guimenu>Settings</guimenu> menu. This will open the - preferences window, illustrated in <xref linkend="config-prefs-fig">. - Preferences are seperated into several categories: - <itemizedlist> - <listitem> - <para> - <guilabel>Identity</guilabel>, which allows you to set - your name, email address, and other information. The - default values are the ones found on your system account. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Mail</guilabel>, which allows you to specify - your email server and protocols, as well as attachment - and HTML handling, forwarding behavior, filters, and - other <application>Evolution</application> behaviors - specific to email. The default behaviors are those - approved by Jamie Zawinski. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Contacts</guilabel>, which allows you to - control addressbook sharing as well as other funcctions - specific to your contact manager. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Calendar</guilabel>, which allows you to set - up calendar networking, as well as the way that your - calendar will behave and appear. The default view is by - week and the default calendar is Western. Time and - date are determined by the system clock and - localization, and cannot be set here. - </para> - </listitem> - - <listitem> - <para> - <guilabel>General</guilabel>, which covers everything - else, including the <application>Evolution</application> - startup screen. - </para> - </listitem> - </itemizedlist> - - </para> - - <!-- ==============Figure===================== --> - <figure id="config-prefs-fig"> - <title>Preferences Dialog</title> - <screenshot> - <screeninfo>Preferences dialog</screeninfo> - <graphic fileref="evolution_config_pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - <!-- ==============End of Figure================--> - - - <sect1 id="config-prefs-identity"> - <title>Identity Settings</title> - <para> - If you have only one email address, or use automatic - forwarding to funnel multiple addresses into one, then you - will only need to configure one identity. To create a single - user with a single identity, enter the following information: - (INSERT detailed DESCRIPTION HERE) - </para> - - <para> - If you have one email accout for your personal life, and one - for work, you'll want to create multiple identities. You - can do this by: (INSERT DESCRIPTION HERE) - </para> - - <note id="config-prefs-identity-note"> - <title>Multiple Identities and Network Settings</title> - <para> - If you use multiple network connections—if, for - example, you dial up an ISP for your personal mail, and use - a LAN for your work-related tasks— you will also have - to set seperate network settings for each identity. - </para> - </note> - </sect1> - - <sect1 id="config-prefs-network"> - <title>Setting up the Network</title> - <para> - In order to do much of anything with - <application>Evolution</application>, you need to connect to - your network. To do that, you'll need to know your user name - and password, what sort of mail sending and receiving - protocols your network uses, and the names of the servers - you'll be using. If you're switching from another groupware - or email progam, you can almost certainly use the same - settings as you did with that program. Select the - <guibutton>Network</guibutton> tab in the - <interface>Preferences</interface> window to get started. - </para> - - <sect2 id="config-prefs-network-advanced"> - <title>Advanced Network Configuration</title> - <para> - INSERT a little introduction paragraph here. - </para> - <sect3 id="config-prefs-network-advanced-multiconnect"> - <title>Multiple Network Connections</title> - <para> - People with who use multiple ISP's or networks, or who - have multiple email accounts, will need to do a little - more work, but not much. - </para> - <example> - <title>Multiple Identities and Networks</title> - <para> - Nate's laptop goes everywhere with him, and he needs - to be able to use <application>Evolution</application> - from anywhere&mdash a hotel room, an airplane, a - client's office, his office, anywhere at all. (INSERT - HOW EVOLUTION HELPS HIM DO THIS). - </para> - </example> - - <para> - (INSERT DESCRIPTION OF WHAT THESE THINGS ARE AND HOW TO - USE THEM) (I'M THINKING IN TERMS OF THE APPLE LOCATION - MANAGER) (Kill this section if Evolution doesn't support - this for 1.0). - </para> - </sect3> - - <sect3 id="config-prefs-network-advanced-other"> - <title>Other Advanced Network Settings</title> - <para> - I can't think of any at the moment but i'm sure they're - out there. They belong here. - </para> - </sect3> - </sect2> - </sect1> - <sect1 id="config-prefs-mail"> - <title>Modifying the Mail</title> - <para> - This section discusses mail-specific preferences. Click on - the <guibutton>Mail</guibutton> tab in the - <interface>Preferences</interface> window to access these - settings. - </para> - <para> - You can set the following options: <!--insert variable list here--> - </para> - </sect1> - - <sect1 id="config-prefs-contact"> - <title>Managing the Contact Manager</title> - <para> - To set the behavior of your Contact Manager, click on the - <guibutton>Contact Manager</guibutton> tab in the - <interface>Preferences</interface> window. - </para> - <para> - You can set the following options: <!--insert variable list - here--> - </para> - </sect1> - - <sect1 id="config-prefs-cal"> - <title>Configuring the Calendar</title> - <para> - This section discusses calendar-specific preferences. Click - on the <guibutton>Calendar</guibutton> tab in the - <interface>Preferences</interface> window to access these - settings. - </para> - <para> - You can set the following options: <!--insert variable list - here--> - </para> - </sect1> - - - <sect1 id="config-prefs-general"> - <title>General Preferences</title> - <para> - Overall Evolution prefs-- whatever else doesn't fit. - </para> - </sect1> - </chapter> -
\ No newline at end of file diff --git a/doc/C/config-setupassist.sgml b/doc/C/config-setupassist.sgml deleted file mode 100644 index ea78865037..0000000000 --- a/doc/C/config-setupassist.sgml +++ /dev/null @@ -1,126 +0,0 @@ - - <chapter id="config-setupassist"> - <title>Easy Setup with the Setup Assistant</title> - <para> - The setup assistant can gather most of the information - necessary for <application>Evolution</application>'s daily - operation. If you prefer more detailed or advanced - configuration, see <xref linkend="config-prefs"> - </para> - <para> - This paragraph will describe all information required by the - setup assistant. It will include a long itemized list, and a - screenshot or two. - </para> - <sect1 id="config-setupassist-mail"> - <title>Mail Setup</title> - <para> - The first time you try to send or receive mail with - <application>Evolution</application>, the <interface>mail - setup druid</interface> will pop up to help you - set up your email preferences. If you don't plan to use - email, or if you'd rather configure your email preferences - later, click <guibutton>Cancel</guibutton>. - </para> - <para> - The setup <glossterm>druid</glossterm> - will guide you through the network configuration process. It - will ask you for some basic information; your system - administrator or ISP should have the answers you'll need. - The mail setup druid is pictured in <xref - linkend="usage-setup-fig">. - -<!-- ==============Figure=================================== --> - - <figure id="usage-setup-fig"> - <title>Mail Setup Druid</title> - <screenshot> - <screeninfo>Evolution Main Window</screeninfo> - <graphic fileref="fig/mail-druid-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure=================================== --> - - - - The druid will ask you for the following information: - <itemizedlist> - <listitem> <para> <guilabel>Name— </guilabel> Your - full name: eg. Eva Lucianne Tester </para></listitem> - - <listitem><para> <guilabel>Email address&mdash</guilabel>; - Your email address: eg. eltester@helixcode.com - </para></listitem> - - <listitem> - <para> - <guilabel> Organization—</guilabel> Any - organization you represent. Leave this blank if you - wish. - </para> - </listitem> - - <listitem><para> <guilabel>Signature File—</guilabel> A text - file appended to any email you send, typically your name - and email address, or a quotation you like. It should be - under three lines of text.</para></listitem> - - <listitem> - <para> - <guilabel>Mail source type—</guilabel> - <application>Evolution</application> supports two mail - sources: POP servers, the most common email server type, - and UNIX-style MBOX files. Ask your system - administrator which one you use. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Server—</guilabel> This should be the - name of your mail server, eg. - mailserver.organization.org - </para> - </listitem> - - <listitem> - <para> - <guilabel> Username— </guilabel>Usually, this is - the part of your email address before the @ character, - and <application>Evolution</application> has selected - that value as the default. If you have a different - username, you can enter it here. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Authentication—</guilabel> Select the - type of authentication you will use. You can click - <guibutton>Detect supported types</guibutton> to find - out which authentication protocols your network allows. - </para> - </listitem> - - - <listitem> - <para> - <guilabel>Mail Transport—</guilabel> This is the - mail sending protocol you will want to use. Sendmail is - the default. - </para> - </listitem> - </itemizedlist> - </para> - <para> - To learn how to configure <application>Evolution</application> - in greater detail, or to change preferences once you have set - them, see <xref linkend="config-prefs">. - </para> - </sect1> - - </chapter> - - - diff --git a/doc/C/config-sync.sgml b/doc/C/config-sync.sgml deleted file mode 100644 index ae78a6daaf..0000000000 --- a/doc/C/config-sync.sgml +++ /dev/null @@ -1,67 +0,0 @@ - <chapter id="config-sync"> - - <!-- THIS ENTIRE CHAPTER MAY BE DELETED --> - - <title>Setting up your synchronization system</title> - <para> - Synchronization presents you with two issues you'll need to - deal with. The first one is pretty simple: you'll need to get - the data to move among the various devices you're using. If - you've already got <application>Gnome-Pilot</application> - working, then all you have to do is tell it to use Evolution - as a conduit. If you haven't used - <application>Gnome-Pilot</application> before, you'll need to - run the GNOME <application>Control Center</application> and go - through the hand-held device setup assistant. Then you can - create the Evolution conduit and press the hotsync button. - </para> - <para> - If that doesn't work, jump up and down several times and swear - loudly. Then make sure you've got - <application>Gnome-Pilot</application> going to the right - device (for my serial port, it's /dev/ttys0, not the default - /dev/pilot) and that you have read and write permission on - that device. If you don't you'll need to be added to whatever - group has those permissions (for my system, it's tty). - Alternately, if you're the only user of your computer and - don't care too much about security, just use - <command>su</command> to become root, and then use - <command>chmod a+rw /dev/[DEVICENAME]</command> to set - universal read and write permissions on that port— just - don't tell your sysadmin I said you could. (Sysadmins, of - course, would never do such a thing.) - </para> - <para> - Once <application>Evolution</application> knows where to get - the mail, address, and calendar data, it needs to know what to - do with it. When you synchronize your local data with the data on - a server or handheld device, you may run into conflicts: - perhaps you have ended up with two cards with the same name - and different addresses, or old mail that has been deleted - from one device but not the other. What if you want to keep - only the most recent mail on your hand-held or your laptop, - but all the mail on the LDAP server or your desktop machine? - Select the <guibutton>Synchronization</guibutton> tab from the - <interface>Preferences</interface> window to set up the - conflict resolution preferences. - </para> - <para> - You can set <application>Evolution</application>'s - synchronization behavior in the following ways: - <!-- LIST HERE --> - </para> - <para> - <warning> - <title>Data Loss Prevention</title> - <para> - It's always a good idea to make a backup. If you set your - synchronization behaviors wrong, you could end up deleting - the messages and cards you want to keep, and keeping the - ones you want to delete. Before you change these - preferences, make a backup of your - <application>Evolution</application> files. You can do - this by... <!--DESCRIBE HERE --> - </para> - </warning> - </para> - </chapter> diff --git a/doc/C/devel-action.sgml b/doc/C/devel-action.sgml deleted file mode 100644 index 5d40c78bf7..0000000000 --- a/doc/C/devel-action.sgml +++ /dev/null @@ -1,18 +0,0 @@ - - <chapter id="devel-actions"> - <title>Actions: Making Evolution Behave</title> - <sect1 id="devel-actions-build"> - <title>Build Actions</title> - <para> - How to create an action. - </para> - </sect1> - - <sect1 id="devel-actions-use"> - <title>Using Actions</title> - <para> - How to use an action you or someone else has built. - </para> - </sect1> - </chapter> -
\ No newline at end of file diff --git a/doc/C/devel-component.sgml b/doc/C/devel-component.sgml deleted file mode 100644 index db4f93c27d..0000000000 --- a/doc/C/devel-component.sgml +++ /dev/null @@ -1,24 +0,0 @@ - - <chapter id="devel-component"> - <title>Evolution Components</title> - <subtitle> Build your own species </subtitle> - <para> - Explain exactly what an Evolution Component is. - </para> - - <sect1 id="devel-component-build"> - <title>Building Evolution Components</title> - <para> - Explain how to build them-- what resources are available, - what interfaces exposed. - </para> - </sect1> - - <sect1 id="devel-component-use"> - <title>Using Additional Evolution Components</title> - <para> - Once you've got one--either you've built it or borrowed it-- - you can use it. Here's how. - </para> - </sect1> - </chapter>
\ No newline at end of file diff --git a/doc/C/devel-script.sgml b/doc/C/devel-script.sgml deleted file mode 100644 index 74dbf161cd..0000000000 --- a/doc/C/devel-script.sgml +++ /dev/null @@ -1,17 +0,0 @@ - - <chapter id="devel-scripts" > - <title>Scripting: Making Evolution Sit up and Beg</title> - <sect1 id="devel-scripts-build"> - <title>Writing Scripts</title> - <para> - How to write scripts for Evolution. - </para> - </sect1> - - <sect1 id="devel-scripts-use"> - <title>Using Scripts</title> - <para> - How to use and install scripts for Evolution. - </para> - </sect1> - </chapter> diff --git a/doc/C/evolution-guide.sgml b/doc/C/evolution-guide.sgml deleted file mode 100644 index 1e76a74a7d..0000000000 --- a/doc/C/evolution-guide.sgml +++ /dev/null @@ -1,136 +0,0 @@ -<!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"> -<!ENTITY USAGE-CONTACT SYSTEM "usage-contact.sgml"> -<!ENTITY USAGE-CALENDAR SYSTEM "usage-calendar.sgml"> -<!ENTITY USAGE-SYNC SYSTEM "usage-sync.sgml"> -<!ENTITY CONFIG-SETUPASSIST SYSTEM "config-setupassist.sgml"> -<!ENTITY CONFIG-PREFS SYSTEM "config-prefs.sgml"> -<!ENTITY CONFIG-SYNC SYSTEM "config-sync.sgml"> -<!ENTITY DEVEL-ACTION SYSTEM "devel-action.sgml"> -<!ENTITY DEVEL-SCRIPT SYSTEM "devel-script.sgml"> -<!ENTITY DEVEL-COMPONENT SYSTEM "devel-component.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"> - -]> - - -<!-- 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> - <authorgroup> - <author><firstname>Aaron</firstname><surname>Weber</surname></author> - <author><firstname>Kevin</firstname><surname>Breit</surname></author> - - </authorgroup> - <copyright> - <year>2000</year><holder>Helix Code, Inc.</holder> - <holder>Kevin Breit</holder> - </copyright> - - <legalnotice> - <para> - PUT THE RIGHT LEGALNOTICE IN HERE - </para> - </legalnotice> - - <releaseinfo> - This is version 0.4 of the Evolution manual. - </releaseinfo> - <!-- this is version of manual, not application --> - -<!-- ########## TO DO LIST: ########### --> - <!-- -finish content. -standardize capitalization/formatting of titles, interface and -component names. -standardize spelling of buzzwords & techterms like email -add glossterms and glossary -standardize on second person, not 1st pers. plural. ---> - - </bookinfo> - - &PREFACE; - - <part id="usage"> - <title>Using Evolution</title> - <subtitle>A Guide for Everybody</subtitle> - <partintro> - <para> - Part one of the <application>Evolution</application> manual - describes how to use <application>Evolution</application> - for email, contact management, and appointment and task - scheduling. You'll find as you go along that, as with most of - Linux, there's more than one way to do things, and you can - pick whichever method you like best. - </para> - </partintro> - - &USAGE-MAINWINDOW; - &USAGE-MAIL; - &USAGE-CONTACT; - &USAGE-CALENDAR; - &USAGE-SYNC; - - </part> - <part id="config"> - <title>Configuring and Managing Evolution</title> - <subtitle>A guide for Power Users and Administrators</subtitle> - <partintro> - <para> - <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. - </para> - </partintro> - - &CONFIG-SETUPASSIST; - &CONFIG-PREFS; - &CONFIG-SYNC; - </part> - <part id="devel"> - <title>Developing for Evolution</title> - <subtitle>An Introduction for the Happy Few</subtitle> - <partintro> - <para> - There are three levels of developing for - <application>Evolution</application>. You can write actions. - You can write scripts. And you can write full-fledged - Evolution components. This paragraph will eventually - desfcribe what that means. - </para> - </partintro> - - &DEVEL-ACTION; - &DEVEL-SCRIPT; - &DEVEL-COMPONENT; - </part> - &APX-GLOSS; - &APX-BUGS; - &APX-AUTHORS; - &APX-FDL; - -</book> - - - - - - - - - - - diff --git a/doc/C/fig/mail-druid-pic.png b/doc/C/fig/mail-druid-pic.png Binary files differdeleted file mode 100644 index f29f3e77be..0000000000 --- a/doc/C/fig/mail-druid-pic.png +++ /dev/null diff --git a/doc/C/fig/mainwindow-pic.png b/doc/C/fig/mainwindow-pic.png Binary files differdeleted file mode 100644 index b7c6067449..0000000000 --- a/doc/C/fig/mainwindow-pic.png +++ /dev/null diff --git a/doc/C/preface.sgml b/doc/C/preface.sgml deleted file mode 100644 index 9ccb257e5e..0000000000 --- a/doc/C/preface.sgml +++ /dev/null @@ -1,159 +0,0 @@ - - <preface id="introduction"> -<!-- =============Introduction ============================= --> - <title>Introduction</title> - - <section id="what"> - <title> What is Evolution, and What Can It Do for Me?</title> - <para> - The idea of evolution as a process of improvement and - development is a strong influence on the developers at Helix - Code. We named our <glossterm>groupware</glossterm> suite - "Evolution" because we knew that it would be able to survive - in the wilderness of the software marketplace for one reason: - it's better. - </para> - <para> - <application>Evolution</application> is a suite of groupware - applications within the GNOME desktop environment that you can - use to send, receive, and organize email, manage address and - other contact information, and maintain a calendar. It - enables you to do those things on one or several computers, - connected directly or over a network, for one person or for - large groups. <application>Evolution</application> can handle - almost all your communications tasks with the power and - flexibility of the GNOME desktop environment. - </para> - <para> - We built <application>Evolution</application> with three groups of - people in mind: everyday users, system administrators, and - developers. - - <itemizedlist> - <listitem> - <para> - For <emphasis>everyday users</emphasis>, we made - <application>Evolution</application> easy to use without - sacrificing power. We made the interface familiar and - intuitive, but also allowed users to customize it to - their liking. We made the setup and configuration as - easy as possible. For any confusion, we wrote a - comprehensive manual and help system. - </para> - </listitem> - <listitem> - <para> - For <emphasis>administrators</emphasis>, we made sure - <application>Evolution</application> met and and - exceeded the standards set by currently available - groupware products, and we developed support for most - major network protocols so that it can integrate - seamlessly with existing hardware and network - environments. All of our efforts have made - <application>Evolution</application> both easy to use - and easy to support. - </para> - </listitem> - <listitem> - <para> - For <emphasis>developers</emphasis>, we built in - support for open standards and protocols 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> offers developers - the ideal environment for cutting-edge application - development. - </para> - </listitem> - <listitem> - <para> - For all three groups, we did our best to ensure the - safety of data. - </para> - </listitem> - </itemizedlist> - </para> - <para> - In action, <application>Evolution</application> makes most - daily tasks faster, because we built it to work with you - instead of against you. For example, it takes only one or two - clicks to enter an appointment or an address card sent to you - by email, or to send email to a contact or appointment. - <application>Evolution</application> makes displays faster and - more efficient, so searches are faster and memory usage is - lower. People who get lots of mail will appreciate - advanced features like <link - linkend="usage-mail-organize-vFolders">vFolders</link>, which - let you save searches as though they were ordinary mail - folders. - </para> - - </section> - - <section id="aboutbook"> - <title>About This Book</title> - <!-- ************** FOLLOWING PARAGRAPH FOR DRAFT ONLY ************* --> - <para> - This version of the <application>Evolution</application> - User's Guide is a <emphasis>draft</emphasis>. It is missing - huge chunks of information, and many of the features it - describes are unimplemented. All the content is subject to - change, especially if you help. Please send comments on the - guide to <email>aaron@helixcode.com</email>. Items that are - known to need action are indicated as such, often with - notation like (INSERT CONTENT HERE). 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. - </para> - <!-- ************* END DRAFT ONLY PARAGRAPH ************** --> - - <para> - This book is divided into three sections. The first section is - a <link linkend="usage">guided tour</link>— 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 advanced users and administrators. If you are - a network administrator, you may find yourself referring to - this section frequently. The third section is a quick <link - linkend="devel">developer's guide</link>, for power users and - hackers. If you want to add advanced scripting to - <application>Evolution</application>, write your own - embeddable components, or simply want to find out just how - powerful <application>Evolution</application> can be, this is - the section for you. - </para> - <para> - Throughout the book, you'll find examples, tips and warnings - to help you along. Most of them are decent, hardworking - pieces of information, and genuinely try to be helpful. Some - of the tips, entitled <emphasis>Bad Ideas</emphasis>, - are, in fact, out to trick you. Please don't follow their - advice, no matter how appealing it may sound. - </para> - <formalpara> - <title>Typographical conventions</title> - <para> - Some kinds of words are marked off with special typography. - It's listed below: - <simplelist> - <member><application>Applications</application></member> - <member><command>Commands</command> typed at the command line</member> - <member><guilabel>Labels</guilabel> for menu items and buttons</member> - <member>Other text treatments</member> - <member>Other text treatments</member> - </simplelist> - </para> - </formalpara> - </section> - </preface> - - - - - - diff --git a/doc/C/usage-calendar.sgml b/doc/C/usage-calendar.sgml deleted file mode 100644 index 83e03c80c0..0000000000 --- a/doc/C/usage-calendar.sgml +++ /dev/null @@ -1,140 +0,0 @@ - - <chapter id="usage-calendar"> - <title>The Evolution Calendar: Time-Tamer Extraordinaire</title> - <para> - To begin using the calendar, select - <guibutton>Calendar</guibutton> from the <interface>shortcut - bar</interface>. By default, the calendar starts in week view mode (IS - THIS TRUE? CHANGE TEXT TO FIT FEATURE). The calendar week view is - shown in <xref linkend="usage-calendar-fig">: - - <!-- ============== Figure ============================= --> - <figure id="usage-calendar-fig"> - <title>Evolution Calendar View</title> - <screenshot> - <screeninfo>Evolution Contact Manager Window</screeninfo> - <graphic fileref="cal-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - <!-- ============== End of Figure ============================= --> - - </para> - <sect1 id ="usage-calendar-view"> - <title>Ways of Looking at your Calendar</title> - <para> - You can view your calendar by the day, by the week, by the - month, or by the year. To do so, click BUTTONS SOMEWHERE. - </para> - <para> - Describe the less-obvious differences among the views of - time here. - </para> - - <para> - In addition, <application>Evolution</application> supports - Hebrew, Muslim, and other calendar formats. To switch to a - different calendar format, choose - <guimenuitem>GUIMENUITEM</guimenuitem> from the - <guimenu>GUIMENU</guimenu>. - </para> - <para> - Describe the ways that different calendars can work here, - and how the different calendars work together. - </para> - </sect1> - <sect1 id="usage-calendar-apts"> - <title>Scheduling With the Evolution Calendar</title> - <para> - The <application>Evolution</application> calendar allows - you to schedule events for yourself or a group of people. - It can handle events that repeat, event lengths from ten - minutes to multiple days, and events that have a date but - no specific time. You can set overlapping events, although - <application>Evolution</application> will warn you about - trying to do two things at once. You can also set event - reminders so that you don't forget about everything you've - just put into your calendar. Basically, it can handle almost - any schedule you throw at it. - </para> - <sect2 id="usage-calendar-apts-basic"> - <title>Creating events</title> - <para> - While looking at the calendar, select <guimenuitem>New - Appointment</guimenuitem> from the - <guimenu>MENU</guimenu>, or press - <keysym>KEYSYM</keysym>. The <interface>New - Appointment</interface> dialog will appear. (INSERT - DESCRIPTION OF INTERFACE HERE: Date, Time, Recurrence, - Reminders, and Tentative/Confirmed) - </para> - <para> - You can alter those settings later by clicking once on the - event in the <interface>calendar view</interface> to - select it, and then choosing <guimenuitem>Event - Properties</guimenuitem> from the - <guimenu>Settings</guimenu> menu. - </para> - </sect2> - - <sect2 id="usage-calendar-apts-group"> - <title>Appointments for Groups</title> - <para> - If you have your calendar set up to work with other - calendars over a network, you can see when others are - available to meet with you. To browse other people's - calendars over your local network, do this: - </para> - <para> - In addition, you can use - <application>Evolution</application> to mark a meeting - request on another person's calendar. To do so, first - select <guimenuitem>New Appointment</guimenuitem> from the - <guimenu>MENU</guimenu>, or press <keysym>KEYSYM</keysym> - to bring up the <interface>new event</interface> window. - Then describe the event as you would any other. Before - you click <guibutton>OK</guibutton>, (INSERT DESCRIPTION - HERE...). <application>Evolution</application> will - automatically send email to each person on the request - list, notifying of the time and date of the meeting you - have requested with them. In addition, it will mark the - event on your calendar and on theirs as tentative, rather than - a confirmed, event. - </para> - <para> - To mark a tentative event as confirmed, click once on the - event in the <interface>calendar view</interface> to - select it, and then choose <guimenuitem>Event - Properties</guimenuitem> from the - <guimenu>Settings</guimenu> menu. In the <interface>Event - Properties</interface> dialog window, click the - "tentative" button to un-mark the event. (NOTE THAT this - feature may not at all exist!) - </para> - </sect2> - - <sect2 id="usage-calendar-apts-privs"> - <title>Scheduling privileges</title> - <para> - There are several levels of scheduling privileges. You - can set whether people can see your calendar, whether they - can request meetings or appointments, and whether they can - create appointments. This section may have to be deleted, - because I don't know if we are going to support privileges - at all. - </para> - </sect2> - </sect1> - - <sect1 id="usage-calendar-organize"> - <title>Organizing your Appointments</title> - <para> - Until I have <application>Evolution</application> running properly, - I have no idea how this sort of organization will actually work. - </para> - <para> - But this section will have at least two paragraphs, and - probably a screenshot. - </para> - </sect1> - </chapter> diff --git a/doc/C/usage-contact.sgml b/doc/C/usage-contact.sgml deleted file mode 100644 index 6cc9cd605f..0000000000 --- a/doc/C/usage-contact.sgml +++ /dev/null @@ -1,288 +0,0 @@ - - <chapter id="usage-contact"> - <title>The Evolution Contact Manager</title> - <para> - The <application>Evolution</application> contact manager can - handle all of the functions of an address book, phone book, - or Rolodex. Of course, <application>Evolution</application> - allows easier updates than an actual paper book, and much - easier synchronization with handheld and remote devices. And - I doubt that you can take your little black book and make it - accessible to the rest of your office over a network. Since - <application>Evolution</application> supports most major - network protocols, including <glossterm>IMAP</glossterm> and - <glossterm>LDAP</glossterm>, it's easy to use over an - existing network. - </para> - <para> - Antother advantage of <application>Evolution</application> - is that the address book is integrated into the rest of - the application. That means that when you look for - someone's address, you can also see a history of - appointments with that person, and when you get an email - with contact information in it, you can create a new address - card very quickly. In addition, searches, folders, and - vFolders all work in the same intuitive way they do in the - other components, so you don't have to learn another system - for similar tasks. - </para> - <para> - This chaper will cover the usage of the - <application>Evolution</application> contact manager, - including organizing large amounts of contact data, sharing - addresses over a network, and the automation - capabilities of the address book. Contact manager - configuration is addressed in <xref - linkend="config-prefs-contact">. - </para> - - <sect1 id="usage-contact-basic"> - <title>Getting Started With the Contact Manager</title> - - <para> - To start managing your contacts, click on - <guibutton>Contacts</guibutton> in the shortcut bar. - </para> - <para> - Describe the interface. Include the fact that the - whole address book consists of a set of cards, organized into - folders. - </para> - </sect1> - <sect1 id="usage-contact-cards"> - <title>Creating, Deleting, and Adding Cards</title> - <para> - You can create a new card by pressing the <guibutton>New - Card</guibutton> button, or by pressing - <keysym>KEYSYM</keysym>. The <interface>New Card</interface> - window will appear. It has the following fields: - - <itemizedlist> - <listitem> <para> - <guilabel>Name:</guilabel> Enter the person's name here - </para></listitem> - <listitem> <para> - - </para></listitem> - <listitem> <para> - <guilabel>Address:</guilabel> - </para></listitem> - - <listitem> <para> - Something - </para></listitem> - - <listitem> <para> - Something - </para></listitem> - </itemizedlist> - </para> - <para> - You can choose which fields an address card has, and create - new fields for cards. For example, - <application>Evolution</application> provides for two line - postal addresses by default, but you may have as many or as - few lines to an address as you wish. To change which - fields an address card has, choose DESCRIBE HERE HOW TO DO - THIS - </para> - - <note> - <title>Quick ways to add cards</title> - <para> - You can add cards from within an email message or calendar - appointment. While looking at an email, right-click on - any email address or message, and choose - <guimenuitem>Create Card for this Address</guimenuitem> or - <guimenuitem>Create Card for this Sender</guimenuitem>from - the menu that appears. While looking at a calendar - appointment, right-click any email address, and choose - <guimenuitem>Create Card for this Address</guimenuitem>. - (NOTE that feature may change! unimplemented!) - </para> - </note> - - <para> - You delete a card by pressing the <guibutton>Delete - Card</guibutton> button, or by dragging it into the trash folder. - </para> - - <para> - You can move cards around just as you would with email: - dragging and dropping works, as does right-clicking and - selecting <guimenuitem>Move</guimenuitem> from the menu - that appears. - </para> - </sect1> - - <sect1 id="usage-contact-organize"> - <title>Organizing your Contact Manager</title> - <para> - Organizing your contact manager is a lot like organizing - your mail. You can have folders and searches the same way - you can with mail, but the contact manager does not allow - vFolders. It does, however, allow each card to fall under - several categories, and allow you to create your own - categories. We'll go over categories in a bit. - </para> - <para> - Another useful UNIMPLEMENTED - <application>Evolution</application> feature is its ability - to recognize when people live together. If two people in - your contact manager share an address, and you change the - address for one of them, Evolution will ask you if you wish - to change the address for both of them, or just for one. - </para> - - <sect2 id="usage-contact-organize-group"> - <title>Groups of contacts</title> - <para> - <application>Evolution</application> lets you put cards - into folders, mark them as members of different groups, - and search through them in a variety of ways. This - section will describe how to organize and find contact - information using <application>Evolution</application>. - CHANGE THIS paragraph: it needs a great deal of work. - </para> - - <sect3 id="usage-contact-organize-group-folder"> - <title>Grouping with Folders</title> - <para> - The simplest way to group address cards is to use - folders. By default, cards start in the - <guilabel>Contacts</guilabel> folder. You can create - more folders inside that one, or create other address - book folders as well. Each card must be in one and only - one folder. - </para> - <para> - To create a new folder, do this: - </para> - <para> - To put a card into a folder, do this: - </para> - </sect3> - - <sect3 id="usage-contact-organize-group-category"> - <title>Grouping with Categories</title> - <para> - The other way to group cards is to mark them as - belonging to different categories. The difference - between folders and categories is that folders contain - cards, but category membership is a property of each - card. That means that you can mark a card as being in - several categories or no category at all. For example, - I put my friend Matthew's card in the "Business" category, - because he works with me, the "Friends" category, because - he's also my friend, and the "Frequent" category, because - I call him all the time and can never remember his phone - number. - </para> - <para> - To mark a card as belonging to a category, do this: - </para> - <para> - Then, you can refer to all the cards in that category - by: - </para> - <para> - If the default categories don't suit you, you can add - your own. Here's how: - </para> - </sect3> - </sect2> - </sect1> - - <sect1 id="usage-contact-sharing"> - <title>Sharing your Cards (and keeping them to yourself)</title> - <para> - Cards can be shared over a network. This is the sort of - feature you'll want to use if your company has a list of - vendors and clients that needs constant updating. If you - also share your calendars, people can avoid duplicating - work and keep up to date on developments within their - workgroup or across the entire company. - </para> - - <example id="usage-contact-sharing-ex"> - <title>Sharing Address Cards and Calendar Data</title> - <para> - I want to schedule a meeting with someone at Company - X, but I'm not sure who to talk to there. Our - corporate network has an address card that states our - contacts there, so I know whom to call. Since we also - share the calendars, I know that Deanna has already - scheduled a meeting with them next Thursday, and I can - either go to the meeting myself or ask Deanna to - discuss my concerns for me. Either way, I avoid - having to schedule yet another meeting with Company X, - which is good since everybody hates their products and - they're doomed to fail anyway. - </para> - </example> - - <para> - Of course, you don't want to share all of your cards— - why overload the network with a list of babysitters, or - tell everyone on your network you're talking to new job - prospects? <application>Evolution</application> lets you - decide which folders you want to make accessible to others. - </para> - <para> - To begin sharing a folder of address cards, select (something) <!-- - DESCRIBE PROCESS HERE -->. The - <interface>Sharing</interface> window will pop up. It contains: - <!--DESCRIBE INTERFACE HERE--> - </para> - </sect1> - - <sect1 id="usage-contact-automate"> - <title>Automating the Contact Manager</title> - <para> - The <application> Evolution</application> contact manager - can perform a wide variety of tasks for you. From speeding - up basic tasks like adding a new address card to managing - mailing lists, you'll find that the contact manager is more - than a mere address book. - </para> - - <sect2 id="contact-automation-basic"> - <title>Send me a card: Adding New Cards Quickly</title> - <para> - When you get information in the mail or in a calendar - entry, you can add it to an address card. To do so, right - click on any email address or email message, and select - <guimenuitem>Add Address Card</guimenuitem> from the menu - that appears. Of course, <application> - Evolution</application> adds cards from a hand-held device - during HotSync operation. For more information about - that, see <xref linkend="usage-sync">. - </para> - </sect2> - - <sect2 id="contact-automation-lists"> - <title>Managing a Mailing list</title> - <para> - You already know that when you are writing an email, you - can address it to one or more people, and that - <application>Evolution</application> will fill in - addresses from your contact manager's address cards if - you let it. In addition to that, you can send email to - everyone in a particular group by doing SOMETHING HERE. - Future versions of <application>Evolution</application> - will allow you to you export a group of cards to a - spreadsheet, database, or word processor so you can print - address labels or prepare large postal mailings. - </para> - </sect2> - <sect2 id="usage-contact-automation-extra"> - <title>Map It! and other extra features</title> - <para> - Need a map or directions? Click - <guibutton>MapIt</guibutton> from within the contact - manager, and <application>Evolution</application> will - map the address for you online. - </para> - </sect2> - </sect1> - </chapter>
\ No newline at end of file diff --git a/doc/C/usage-mail.sgml b/doc/C/usage-mail.sgml deleted file mode 100644 index 2dd289e4c3..0000000000 --- a/doc/C/usage-mail.sgml +++ /dev/null @@ -1,776 +0,0 @@ - - <chapter id="usage-mail"> - <title>Evolution Mail</title> - <abstract> - <title> An Overview of the Evolution Mailer</title> - <para> - Email is an integral part of life these days, and - <application>Evolution</application> mail is here to help - you keep track of it. <application>Evolution</application> - email is like other email programs in all the ways you would - hope: - <itemizedlist> - <listitem> - <para> - Item: Description - </para> - </listitem> - <listitem> - <para> - Item: Description - </para> - </listitem> - <listitem> - <para> - Item: Description - </para> - </listitem> - </itemizedlist>. - </para> - <para> - However, <application>Evolution</application> has some - important differences. First, it's built to handle very - large amounts of mail without slowing down or crashing. We - had high mail volumes in mind when we designed our <link - linkend="usage-mail-organize-filters">filtering</link> and - <link linkend="usage-mail-organize-search">searching</link> - functions. There's also the - <application>Evolution</application> <link - linkend="usage-mail-organize-vFolders">vFolder</link>, an - advanced organizational feature not found in other mail - clients. If you get a lot of mail, or if you keep every - message you get in case you need to refer to it later, - you'll find that feature especially useful. - </para> - - <para> - You can start reading email by clicking - <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 - Code welcoming you to the application. - </para> - </abstract> - - <sect1 id="usage-mail-getnsend"> - <title>Reading, Getting and Sending Mail</title> - <sect2 id="usage-mail-getnsend-read"> - <title>Reading a Message</title> - <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. - </para> - <para> - Go ahead and right-click on the message, and select - <guimenuitem>Delete Message</guimenuitem> from the menu - that appears. The message will move into the - <guilabel>Trash</guilabel> folder. If you want to keep - it, you can open the <guilabel>Trash</guilabel> folder - and drag the message back to your - <guilabel>Inbox</guilabel>. The trash will be - automatically emptied the next time you quit - <application>Evolution</application>. (FEATURE - UNIMPLEMENTED! Text may change to fit featureset) - - <!-- ==============Figure=================================== --> - <!-- MAKE SURE THIS SCREENSHOT HAS THE WELCOME MESSAGE! --> - <figure id="usage-mail-intro-fig"> - <title>Evolution Mail</title> - <screenshot> - <screeninfo>Evolution Mail</screeninfo> - <graphic fileref="fig/mainwindow-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - <!-- ==============End of Figure=================================== - --> - </para> - </sect2> - - - - <sect2 id="usage-mail-getnsend-get"> - <title>Getting Mail</title> - <para> - To check your email, just click <guibutton>Send and - Receive</guibutton> in the toolbar. If this is the first - time you've done so, the <interface>mail druid</interface> - will ask you for the information it needs to check your - mail (see <xref linkend="config-setupassist"> for more - information). Then, <application>Evolution</application> - will download your mail for you and send any mail you've - marked ready to send. New mail will appear in your - <interface>Inbox</interface> and also in the - <interface>Today View</interface>. - </para> - - <para> - If you get an error message instead of mail, you probably - need to change your network preferences. To learn how to - do that, have a look at <xref - linkend="config-prefs-network">, or ask your system - administrator. - </para> - - <sect3 id="usage-mail-getnsend-get-attach"> - <title>Attachments, HTML Mail, and Live Documents</title> - <para> - If you receive a file attached to an email, - <application>Evolution</application> will ask where you - want to put it. Once you've downloaded a file, you can - open, move, copy, or execute it just like any other, - using <application>Nautilus</application> or your - favorite shell or file manager. (This text will change - to fit app behavior, once features are implemented.) - </para> - - <para> - <application>Evolution</application> can also display - HTML-formatted mail, complete with graphics. HTML - formatting will display automatically, although you can - turn it off if you prefer. - </para> - - <para> - It can also display <glossterm>live - documents</glossterm>, which have scripted or - executable contents— for example, a working - spreadsheet page or a chess game. - </para> - <tip id="badidea-attachment"> - <title>Bad Idea</title> - <para> - When someone you don't know sends you an attached - program, go ahead and run it. Set your preferences to - always run live documents when you recieve them, too. - Everybody knows all that virus stuff is just a Windows - problem. - </para> - </tip> - </sect3> - </sect2> - - <sect2 id="usage-mail-getnsend-send"> - <title>Writing and Sending Mail</title> - <para> - You can start writing a new - email message by selecting <guimenuitem>New - Mail</guimenuitem> from the <guimenu>File Menu</guimenu>, - or by pressing <keysym>Ctrl-N</keysym>. When you do so, - the <interface>New Message</interface> window will open, - as shown in <xref linkend="usage-mail-newmsg-fig">. - </para> - -<!-- ==============Figure=================================== --> - <figure id="usage-mail-newmsg-fig"> - <title>New Message Window</title> - <screenshot> - <screeninfo>Evolution Main Window</screeninfo> - <graphic fileref="newmsg-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure=================================== --> - - <para> - Enter an address in the <guilabel>To:</guilabel> field, a - message in the <guilabel>Message:</guilabel> field, and - press <guibutton>Send and Receive</guibutton>. That's - easy. It may even be too easy, which is why I like to - queue my messages up to be sent a few minutes later. - - <tip id="usage-mail-getnsend-send-attach-tip"> - <title>Send Now, Send Later</title> - <para> - Evolution will send mail immediately unless you tell - it to do otherwise by selecting <guimenuitem>Send - Later</guimenuitem> from the <guimenu>MENU</guimenu>. - Then, when you press <guibutton>Send & - Receive</guibutton>, all your unsent messages will go - out at once. I like to use "Send Later" because it - gives me a chance to change my mind about a message - before it goes out. That way, I don't send anything I'll - regret the next day. - </para> - <para> - To learn more about how you can specify message queue - and filter behavior, see <xref linkend="config-prefs-mail">. - </para> - </tip> - </para> - - <para> - There is quite a bit more to sending mail, though. In the - next few sections, you'll see how - <application>Evolution</application> handles additional features, - including mailing lists, attachments, and forwarding. - </para> - - - <sect3 id="usage-mail-getnsend-send-to"> - <title>Choosing Recipients</title> - <para> - If you have created address cards in the contact - manager, you can also enter nicknames or other portions - of address data, and - <application>Evolution</application> will complete the - address for you. (INSERT description of UI for this - feature, once it is decided upon). If you enter a name - or nickname that can go with more than one card, - Evolution will open a dialog box to ask you which person - you meant. (QUESTION: will users be able to drag & drop - address cards to send email?). For more information - about using email together with the contact manager and - the calendar, see <xref - linkend="usage-contact-automate"> and <xref - linkend="usage-calendar-apts-group">. - </para> - <para> - In addition, you can mark recipients in three different - ways. The <guilabel>To:</guilabel> field is for the - primary recipients of the message you are going to send. - However, it is considered bad form to have more than a - few email addresses in this section. - </para> - <para> - If you're writing to one person, but want to keep a - third party up to date, you can use - <guilabel>Cc:</guilabel>. Hearkening back to the dark - ages when people used typewriters and there were no copy - machines, "Cc" stands for "Carbon Copy." Use it - whenever you want to share a message you've written to - someone else. - <example> - <title>Using the Cc: field</title> - <para> - Say, for example, Susan sends an email to a client. - She puts her co-worker, Tim, in the in the - <guilabel>Cc:</guilabel> field, so that he know - what's going on. The client can see that Tim also - recieved the message, and know that they can talk - to Tim about the message as well. - </para> - </example> - </para> - <para> - If you have a large number of recipients, or if you want - to send mail to several people without sharing the - recipient list, you should use - <guilabel>BCc:</guilabel>. "BCc" stands for "Blind - Carbon Copy", and means that people listed in the - <guilabel>BCc:</guilabel> are excluded from the - recipient list, although they will receive the message - and the list of addresses from the - <guilabel>To:</guilabel> and <guilabel>Cc:</guilabel> - fields. - - <example id="ex-mail-bcc"> - <title>Using the BCc: field</title> - <para> - Let's say Tim sends an email to a client, and wants - his supervisor to know what he wrote. He doesn't, - however, want the client to start writing his - supervisor about the project— it's Tim's job - to deal with the client. So Tim puts his - supervisor's email address in the - <guilabel>BCc:</guilabel> field. That way, the - client has one contact, and the boss stays in the - loop. - </para> - </example> - </para> - </sect3> - - <sect3 id="usage-mail-getnsend-send-reply"> - <title>Replying to Messages</title> - <para> - In order to reply to a message, click on it once in the - message list to select it. Then press the - <guibutton>Reply</guibutton> button, or use the - <keysym>REPLY COMBO</keysym> hot key. A window like - the <interface>New Message</interface> window will - appear, but the subject will already be present— - typically, your new message will have the same subject - as the message to which you are replying, but with Re: - before it, to mark it as a reply. In addition, the - full text of the previous message may be inserted into - the new message, with the > character before each - line. This indicates quoting. You can intersperse - your message with the quoted material as shown in <xref - linkend="usage-mail-getnsend-reply-fig"> - -<!-- note that this figure should have a reply mail ready to send, with quoted materials and the relevant replies interspersed--> -<!-- ==============Figure=================================== --> - <figure id="usage-mail-getnsend-reply-fig"> - <title>Reply Message Window</title> - <screenshot> - <screeninfo>Evolution Main Window</screeninfo> - <graphic fileref="replymsg-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure=================================== --> - - </para> - - <para> - If a message has several recipients, as in the case of - mailing lists or messages that have been carbon copied, - you may wish to select one of the items under the - <guimenuitem>Reply-To</guimenuitem> submenu on the - <guimenu>MENU</guimenu> menu. This will allow you to - choose one or several of the other message recipients in - addition to the person who originally sent you the - message. If there are large numbers of people in the - <guilabel>Cc:</guilabel> or <guilabel>To:</guilabel> - fields, this can save substantial amounts of time. In - addition, Reply-To makes it very easy to keep off-topic - conversation away from mailing lists and newsgroups. - <example> - <title>Using the Reply-To feature</title> - <para> - Returning again to the email Susan sent to Tim and - their client, you'll note that the Reply-To feature - allows the client to decide whether to reply just to - Susan, or to both Tim and Susan by selecting - a menu item, rather than by cutting and pasting the - email addresses. - </para> - </example> - </para> - </sect3> - - <sect3 id="usage-mail-getnsend-send-fancy"> - <title>Embellishing that email</title> - <para> - <application>Evolution</application> allows you to - make your email more attractive in a number of ways. You - can send messages formatted with HTML, attach any sort - of file to them, and even include live documents, like - spreadhseets or chess games. This section will tell - you how. - </para> - - <sect4 id="usage-mail-getnsend-send-html"> - <title>Colors, pictures, and fonts with HTML Mail</title> - <para> - Most email messages are sent as plain text, but they - can also be sent as HTML, which means they can include - color, text style, and other formatting information. - Evolution will read and display HTML properly without - trouble, and also allows you to send outgoing - email messages as HTML. To send an HTML message, just - use the composition toolbar to add formatting; - your message text will appear formatted in the composer - window, and the message will be sent as HTML. - </para> - <note> - <title>A Technical note on HTML Tags</title> - <para> - Any text, including HTML tags, entered into the - message composition window is assumed to be plain - text. If you enter HTML directly into the - composer— say, <markup - role="html"><BR>Bold Text</BR></markup>, - the the composer will assume you meant exactly that, - and not "make this text bold," as a HTML composition - tool would. For the very technically inclined, that - means that when the text <markup - role="html"><BR></markup> is sent as HTML, it - will be converted to the string - <literal>&lt;BR&gt;</literal>. - </para> - </note> - <para> - Some people do not have HTML-capable mail clients, or - prefer not to receive HTML-enhanced mail because it is - slower to download and display. - <emphasis>Some</emphasis> people refer to HTML mail as - "the root of all evil" and get very angry if you send - them HTML mail, which is why the default in - <application>Evolution</application> is plain text. - If you choose to send HTML mail, but have an address - book entry for someone who does not wish to receive - HTML-enhanced mail, you can note that preference in - their address card. The mailer will automatically - strip the HTML tags from any messages you send to that - address. - </para> - </sect4> - - <sect4 id="usage-mail-getnsend-send-attach"> - <title>Attachments</title> - <para> - If you want to attach a file to your email message, - you can do so by <!--describe process here-->. If - your recipients can read HTML mail, you can put an - image inside the mail by dragging the file into the - composer window, or by selecting <guimenuitem>Menu - Item</guimenuitem> from the <guimenu>Menu</guimenu> - menu. Still, unless you know what email client the - recipient is using, it's best to send a message or - attachment in the simplest manner possible. - </para> - </sect4> - <sect4 id="usage-mail-getnsend-send-live"> - <title>Live Documents</title> - <para> - Later versions of <application>Evolution</application> - will allow you to enliven your email with almost any - sort of document, and even with entire - applications. At this point, however, I don't know how - that will work. - </para> - </sect4> - </sect3> - - <sect3 id="usage-getnsend-fwd"> - <title>Forwarding Mail</title> - <para> - <guilabel>Forward</guilabel> is useful if you have - received a message and you think someone else would like - to see it, or if you get a message intended for someone - else. You can forward a message as an attachment to a - new message (the default way of forwarding) or you can send it - <glossterm>inline</glossterm> as a quoted portion of the - message you are sending. Attachment forwarding is best - if you want to send the entire message you received, - unaltered. Inline forwarding is best if you want to - send portions of a message, or if you have a large - number of comments on different sections of the message - you are forwarding. Remember to note from whom the - message came, and where, if at all, you have removed or - altered content. - </para> - <para> - To forward a message, first make sure it is selected by - clicking it once in the message list. Then, press - <guibutton>Forward</guibutton> on the toolbar, or select - SOMETHING. To forward a message inline instead of as an - attachment, DO SOMETHING ELSE. Choose an addressee as - you would when sending a new message; the subject will - already be entered, but you can alter it. Enter your - comments on the message in the <interface>composition - frame</interface>, and press <guibutton>Send and - Receive</guibutton>. To forward it - <glossterm>inline</glossterm> instead of attached, - select <guimenuitem>Forward Inline</guimenuitem> from - the <guimenu>Message</guimenu> menu. - </para> - </sect3> - <sect3 id="usage-mail-getnsend-ettiquette"> - <title>Seven Tips for Email Usage</title> - <para> - I started with ten, but four were "Don't send - <glossterm>spam</glossterm>." - <itemizedlist> - <listitem> - <para> - Always begin and close with a salutation. Say - "please" and "thank you", just like you do in real - life. You can keep your pleasantries short, but be pleasant! - </para> - </listitem> - - <listitem> - <para> - ALL CAPS MEANS YOU'RE SHOUTING! - </para> - </listitem> - - <listitem> - <para> - Never write anything in email you wouldn't say in - public. Old messages have a nasty habit of - resurfacing when you least expect them to. - </para> - </listitem> - - <listitem> - <para> - Check your spelling and use complete sentences. - </para> - </listitem> - - <listitem> - <para> - Don't send nasty emails (flames). If you get one, - don't write back. - </para> - </listitem> - - <listitem> - <para> - Don't send spam or forward chain mail. If you - must, verify any rumors, and make sure the - message doesn't have multiple layers of email - quotation symbols (>) indicating multiple - layers of careless inline forwarding. - </para> - </listitem> - - <listitem> - <para> - When you reply or forward, include just enough of - the previous message to provide context. Not too - much, not too little. - </para> - </listitem> - </itemizedlist> - </para> - <para> Happy mailing! </para> - </sect3> - </sect2> - </sect1> - - <sect1 id="usage-mail-organize"> - <title>Organizing Your Mail</title> - <para> - Even if you only get a few email messages a day, you - probably want to sort and organize them. When you get a - hundred a day and you want to refer to a message you - received six weeks ago, you need to sort and organize them, - and <application>Evolution</application> has the tools to - help you do it. - </para> - - <sect2 id="usage-mail-organize-folders"> - <title>Getting Organized with Folders</title> - <para> - Mail, as well as address cards and calendars, is kept in - folders. If you like, you can create new folders by - selecting <guisubmenu>New</guisubmenu> and then - <guimenuitem>Folder</guimenuitem> from the - <guimenu>File</guimenu> menu, or by pressing - <keysym>COMBO</keysym>. (Will there be a dialog box to - determine name and location? Must wait for feature to - describe.) The new folders will appear in the - <interface>tree view</interface>, and you can drag them - wherever you want to relocate them. You can move messages - into the folders by dragging and dropping, or by selecting - them and choosing <guimenuitem>ITEM</guimenuitem> from the - <guimenu>MENU</guimenu>. If you create filters with the - <interface>filter druid</interface>, you can have mail - moved to a folder automatically. An email message can be in - only one folder at a time, just like real mail in real - folders. This is also the case for folders of address - cards and calendar information. - </para> - </sect2> - - <sect2 id="usage-mail-organize-search"> - <title>Searching for Messages</title> - <para> - Because <application>Evolution</application> automatically - creates an index of every email you send or receive, it - can search through your old messages and present you with - results very quickly. You can search for messages by - author, subject, keyword, or headers. (INSERT descriptons - of what those terms mean) - </para> - <para> - To create a search, enter the word or phrase you're - looking for in the form field below the toolbar, and - choose a search type: - <itemizedlist> - <listitem> - <para> - <guilabel>Body or subject contains:</guilabel> This - will search message subjects and the messages - themselves for the word or phrase you've entered in - the search field. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Body contains:</guilabel> This will search - only in message text, not the subject lines. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Subject contains:</guilabel> This will - show you messages where the search text is in the - subject line. It will not search in the message body. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Body does not contain:</guilabel> This - finds every email message that does not have the - search text in the message body. It will still show - messages that have the search text in the subject - line, if it is not also in the body. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Subject does not contain:</guilabel>This - finds every mail whose subject does not - contain the search text. - </para> - </listitem> - </itemizedlist> - - </para> - </sect2> - - <sect2 id="usage-mail-organize-vFolders"> - <title>Getting Really Organized with Virtual Folders</title> - <para> - If you find yourself performing a search frequently, you - can save it as a virtual folder. Virtual folders, or - vFolders, are an advanced way of viewing your email - messages within <application>Evolution</application>. If - you get a lot of mail or often forget where you put - messages, vFolders can help you stay on top of things. - </para> - <para> - A vFolder looks and acts a lot like a folder, but it's - actually a saved search that you can access in most of the - same ways you would a regular folder. The one important - differences between them is that a conventional folder - actually contains messages, but a vFolder is a view of - messages that may be in several different folders. This - means that while a message may fall into several vFolders, - it can be in only one conventional folder. Also, it means - that you cannot remove a message from a vFolder unless you - delete it, and you cannot add a message to a vFolder - unless you change the vFolder's search criteria. - </para> - <para> - As messages that meet the vFolder criteria arrive or are - deleted, <application>Evolution</application> will - automatically place them in and and remove them from the - vFolder contents list. When you delete a message, it gets - erased from the folder it actually exists in as well as - any vFolders which include it. - </para> - <para> - That's pretty complicated. But it can be useful. For - example, if I have a folder for all the email from one - person, and another folder for all the email on a given - topic, I feel organized. But when the person sends me - mail about the topic, my whole email filing universe - becomes chaotic. I need vFolders to save the day for me. - </para> - <para> - That sounds silly, but imagine a business trying to keep - track of mail from hundreds of vendors and clients, or a - university with overlapping and changing groups of - faculty, staff, administrators and students. The larger - the system, the less you can afford that sort of - confusion. vFolders make for better organization because - they can accept overlapping groups in a way that regular - folders and filing systems can't. - </para> - - <example id="usage-mail-organize-vFolders-ex"> - <title>Using Folders, Searches, and vFolders</title> - <para> - To organize my mail box, I can set up a vFolder - for emails from my friend Vince, by doing (INSERT - PROCESS HERE). Then, whenever I want to see the - messages Vince has sent me, I open the vFolder, and - every message he's sent me shows up, no matter where - I've actually filed it. If I want, I can also create a - vFolder containing any message from my list of - co-workers which also has the name of the project in - it. That way, when Vince sends me mail about the - project, I can see that message both in the "Vince" - vFolder and in the "Project" vFolder. That's because - when I open up the "Vince" folder, I'm really - performing a search for all the mail from Vince, and - when I open the "Project" folder I'm really performing - a search for all the mail about the project. - - (INSERT SCREENSHOT HERE) - - </para> - </example> - </sect2> - - <sect2 id="usage-mail-organize-filters"> - <title>Staying organized: Mail Filters in Evolution</title> - <para> - Filters sort your email for you. People who subscribe to - multiple mailing lists, or who often need to refer to - messages they have sent, find filters especially helpful - to seperate personal from list-related mail, but they're - good for anybody who gets more than a few messages a day. - To create a filter, go to your - <interface>Inbox</interface>. Then select - <guimenuitem>Filter Druid</guimenuitem> from the - <guimenu>Tools</guimenu> menu. This will start the a - <glossterm> druid</glossterm>, which will allow you to - create filters. - </para> - - <para> The <interface>filter druid</interface> window - contains a window listing rules, and an option to create a - new rule. To start filtering your mail, click - <guibutton>Add</guibutton> to add a filtering rule. - You'll decide when it should take place: - <itemizedlist> - <listitem> - <para> - <guilabel>When mail arrives:</guilabel> Select - this option to have messages filtered as they - arrive. - </para> - </listitem> - <listitem> - <para> - <guilabel>When mail is sent:</guilabel> Select - this option to filter your outgoing mail. You - can use this feature to keep your - <interface>Outbox</interface> as organized as - your <interface>Inbox</interface>. - </para> - </listitem> - </itemizedlist> - </para> - - <para> - Then, the filter druid will ask you which emails it should - act upon. You can set criteria to include words or phrases - in the subject, To:, Cc: or body of the message. Once - you've decided which messages to filter, the druid will ask - you the sort of action you wish to take. More details and - screenshots should follow here. - </para> - - - <note> - <title>Two Notable Filter Features</title> - <para> - <itemizedlist> - <listitem><para>Any incoming email that does not meet - filter action criteria remains in the Inbox. </para> - </listitem> - - <listitem><para>If you move a folder, your filters - will follow it. </para></listitem> - </itemizedlist> - </para> - </note> - </sect2> - </sect1> - </chapter> -<!-- ================ END OF MAILER CHAPTER ============= --> diff --git a/doc/C/usage-mainwindow.sgml b/doc/C/usage-mainwindow.sgml deleted file mode 100644 index a917f3a71f..0000000000 --- a/doc/C/usage-mainwindow.sgml +++ /dev/null @@ -1,264 +0,0 @@ - - <chapter id="usage-mainwindow"> - - <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.After - <application>Evolution</application> starts up, you will see - the <interface>main window</interface>, which looks a lot like - in <xref linkend="usage-mainwindow-fig">. On the left of the - <interface>main window</interface> are the <interface>shortcut - bar</interface> and the <interface>tree-view</interface>. - Just underneath the title bar is a series of menus in the - <interface>menu bar</interface>, and below that, the - <interface>tool bar</interface> with buttons for different - functions. The largest part of the <interface>main - window</interface> is taken up by a welcome message. <!-- - para does not end here but after fig! --> - -<!-- ==============Figure=================================== --> - -<!-- -Make sure that this figure meets its descriptions below: it should -show the shortcut bar, the tree view with some trees expanded, and so -forth. Can these things be labelled with little arrows & stuff? - --> - - <figure id="usage-mainwindow-fig"> - <title>Evolution Main Window and Inbox</title> - <screenshot> - <screeninfo>Evolution Main Window</screeninfo> - <graphic fileref="fig/mainwindow-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure=================================== --> - - - <note> - <title>The Way Evolution Looks</title> - <para> - The appearance of both - <application>Evolution</application> and - <application>GNOME</application> is very easy to - customize, so your screen might not look like this - picture. You might configure - <application>Evolution</application> to start with a - different view, or without the <interface>shortcut - bar</interface> or <interface>tree view</interface>. - </para> - </note> - </para> - - <sect1 id="usage-mainwindow-shortcutbar"> - <title>The Shortcut Bar</title> - <para> - The buttons in the <interface>shortcut bar</interface> give - you quick access to the different functions that - <application>Evolution</application> provides. - </para> - <para> - The buttons in the <interface>shortcut bar</interface> are: - <itemizedlist> - <listitem> - <para> - <guibutton>Today</guibutton>, which will bring up a summary - of any new messages you've recieved, along with the tasks and - appointments you have lined up for today. - </para> - </listitem> - - <listitem> - <para> - <guibutton>Inbox</guibutton>, which will show you all - of your email. Your Inbox is also where you can - access Evolution's tools to filter, sort, organize, - and search your mail. - </para> - </listitem> - - <listitem> - <para> - The <guibutton>Calendar</guibutton>, which can store - appointments for you. Connected to a network, you - can use it to keep a group of people on schedule and - up to date. - </para> - </listitem> - - <listitem> - <para> - The <guibutton>Contacts</guibutton> tool holds your - addresses, phone numbers, and contact information. - Like calendar information, contact data can be - synchronized with hand-held devices and shared over a - network. - </para> - </listitem> - - <listitem> - <para> - The <guibutton>Tasks</guibutton> tool combines a "to - do" list with reminders to help you keep track of - daily events. - </para> - </listitem> - - <listitem> - <para> <guibutton>Notes</guibutton> is your catch-all - notepad: write <glossterm>haiku</glossterm>, take down - messages from phone conversations, or keep small - things organized. - </para> - </listitem> - </itemizedlist> - - - </para> - <para> - If you prefer to use a keyboard shortcut, or <glossterm>hot - key</glossterm>, you can use those instead. They're - shown... (INSERT DESCRIPTION) 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 <guimenuitem>Hide/Show Shortcut - Bar</guimenuitem> from the <guimenu>MENU</guimenu> menu. - </para> - </sect1> - - <sect1 id="usage-mainwindow-treeview"> - <title>The Tree View</title> - <para> - The <interface>tree view</interface> is the most comprehensive way to - get to your information: it can show you everything you've - stored with <application>Evolution</application> - appointments, address cards, emails, and so forth. - - The <interface>tree view</interface> display presents your - data like a <glossterm>file tree</glossterm>— it - starts small at the top, and branches downwards. There are a - few folders you will always see, because they're at the top. - On my computer, I have only one: <guilabel>Local</guilabel>. - When I click on the plus sign next to the label, I see the - contents: - <itemizedlist> - <listitem> - <para> - <guilabel>Calendar</guilabel>, where you'll find the - appointments and event listings. - </para> - </listitem> - <listitem> - <para> - <guilabel>Contacts</guilabel>, where your address - cards are stored. - </para> - </listitem> - <listitem> - <para> - <guilabel>Directories</guilabel>, for directories, which - have not been implemented yet. - </para> - </listitem> - <listitem> - <para> - <guilabel>Inbox</guilabel>, for your incoming mail. - This is where you will make the most subfolders. - </para> - </listitem> - <listitem> - <para> - <guilabel>Outbox</guilabel>, where you can store - copies of mail you have sent, or unsent drafts. - </para> - </listitem> - <listitem> - <para> - <guilabel>Trash</guilabel>, where you can throw things away. - </para> - </listitem> - </itemizedlist> - - </para> - - <para> - Right-clicking will bring up a menu for just about anything - in GNOME, and <application>Evolution</application> is no - exception. If you right-click on a folder, you'll have a - menu with the following options: - <itemizedlist> - <listitem><para>Something</para></listitem> - <listitem><para>Something</para></listitem> - <listitem><para>Something</para></listitem> - </itemizedlist>. - </para> - - <tip> - <title>Context-Sensitive Help</title> - <para> - You can almost always get help on an item by - right-clicking it. If you're not sure what something is, - or don't know what you can do with it, right-clicking and - choosing <guimenuitem>Help</guimenuitem> is a good way to - find out. - </para> - </tip> - - <para> - If a folder has other folders in it, there will be a plus - sign next to it. Click on the plus sign, and the folder will - open to let you see the other folders inside. This may - change in the future to something more attractive, like - triangles that drop down as you click on them to display the - rest of the tree. - </para> - - <para> - Any time new information arrives in a folder, that folder - will be highlighted, or its label displayed as bold - text. You can learn more about customizing - <application>Evolution</application> alerts and appearance - in <xref linkend="config">. - </para> - - <para> - Moving and deleting folders and other items works in one of - two ways: using <glossterm>drag-and-drop</glossterm> or by - right-clicking and selecting an item from the - <interface>right-click menu</interface>. You can drag the - folders inside the tree view to change their order or put - one folder inside another. To delete a folder, drag it into - the trash folder or right-click it and select - <guimenuitem>Delete</guimenuitem> from the menu that pops - up. The same goes for individual messages, appointments, - and address cards, whether they're in the <interface>tree - view</interface> or not: drag them where you want them, and - they will go there. <!-- ****This paragraph could use some - work**** --> - </para> - <para> - You can also use the <guimenu>right-click menu</guimenu> to - move, rename, and delete folders. - <guimenuitem>Delete</guimenuitem> function from the - <guimenu>right-click menu</guimenu>. - </para> - <para> - Once you've familiarized yourself with the <interface>main - window</interface> you can start doing things with it. - We'll start with your email inbox: you've got a letter - waiting for you already. - </para> - </sect1> - </chapter> - - - - - - diff --git a/doc/C/usage-sync.sgml b/doc/C/usage-sync.sgml deleted file mode 100644 index f28ebc10cc..0000000000 --- a/doc/C/usage-sync.sgml +++ /dev/null @@ -1,19 +0,0 @@ - - <chapter id="usage-sync"> - <title>Synchronizing with a Hand-held Device</title> - <para> - Once you've set up a synchronization system, it pretty much - takes care of itself. Not only that, it's entirely possible - that your system administrator has set it up for you. All - that this chapter covers is how to use that system once it's - installed and configured. If you need to set it up, consult - <xref linkend="config-sync">. - </para> - - <para> - If you've already got Gnome-pilot set up to use - <application>Evolution</application> all you need to do is put - your hand-held device on the cradle and press the HotSync - button. No, really. That's all there is to it. - </para> - </chapter>
\ No newline at end of file diff --git a/doc/Camel-Classes b/doc/Camel-Classes deleted file mode 100644 index 93aec087dd..0000000000 --- a/doc/Camel-Classes +++ /dev/null @@ -1,35 +0,0 @@ -CamelException -CamelProvider -CamelThreadProxy -CamelURL -GtkObject - + CamelObject - + CamelAddress - | + CamelInternetAddress - | ` CamelNewsAddress - + CamelDataWrapper - | + CamelMedium - | | ` CamelMimePart - | | ` CamelMimeMessage - | ` CamelMultipart - + CamelFolder - | ` CamelFolderPtProxy - + CamelFolderSearch - + CamelFolderSummary - + CamelMimeFilter - | + CamelMimeFilterBasic - | + CamelMimeFilterCharset - | + CamelMimeFilterIndex - | ` CamelMimeFilterSave - + CamelService - | + CamelStore - | ` CamelTransport - + CamelSession - + CamelStream - | + CamelSeekableStream - | | + CamelSeekableSubstream - | | + CamelStreamFs - | | ` CamelStreamMem - | + CamelStreamBuffer - | ` CamelStreamFilter - ` CamelThreadProxy
\ No newline at end of file diff --git a/doc/ChangeLog b/doc/ChangeLog deleted file mode 100644 index d56b709778..0000000000 --- a/doc/ChangeLog +++ /dev/null @@ -1,134 +0,0 @@ -2000-05-27 Aaron Weber <aaron@helixcode.com> - - * C/evolution-guide.sgml: added Kevin Breit to author and - copyright. - - * C/apx-authors.sgml: Put app authors in a simplelist. - - * C/usage-mail.sgml: Removed USAGE-SETUP insertion, added xref to send - users to config-setupassist chapter. This and the following changes - take setup druid coverage out of usage - section and put it in config section. - * C/config-setupassist.sgml: Added mail druid coverage from - usage-setup.sgml. - * C/usage-setup.sgml: Removed file. contents in - config-setupassist.sgml. - * C/evolution-guide.sgml: Removed - USAGE-SETUP entity (and file usage-setup.sgml.) - - -2000-05-26 Aaron Weber <aaron@helixcode.com> - - * C/fig/mainwindow-pic.png: new file - * C/fig/mail-druid-pic.png: new file - * C/fig: New directory, for figure graphics. - - * C/apx-gloss.sgml: new file. glossary. thx. to kevin from chicago. - - * C/usage-setup.sgml: More accurate description of druid, and - moved to mail section-- see usage-mail.sgml entry. This is a new - location for this entity, and it may move more later. - - - * C/usage-mainwindow.sgml: altered description of starting - evolution. added screenshot for main-window picture. - - * C/usage-mail.sgml: added screenshots, added coverage of setup - druid and put it into get-and-send section, which is probably not - where it should stay. Also started filter druid coverage and - clarified examples, esp. in Bcc: section. - - * C/usage-contact.sgml: Clarified examples. - - * C/preface.sgml: rewording of "what is" and "about book" sections. - - * C/evolution-guide.sgml: added glossary entity APX-GLOSS, altered - phrasing in part intros, changed order of Setup-assistant section. - - * C/config-prefs.sgml: changed wording, removed ref. to re-running - setup assistant. - -2000-05-18 Aaron Weber <aaron@helixcode.com> - - * C/evo_book_0.1.sgml: removed. - - * C/apx-authors.sgml: new file. - * C/apx-bugs.sgml: same. - * C/apx-fdl.sgml: same. - * C/config-prefs.sgml: same. - * C/config-setupassist.sgml: same. - * C/config-sync.sgml: same. - * C/devel-action.sgml: same. - * C/devel-component.sgml: same. - * C/devel-script.sgml: same. - * C/evolution-guide.sgml: same. - * C/preface.sgml: same. - * C/usage-calendar.sgml: same. - * C/usage-contact.sgml: same. - * C/usage-mail.sgml: same. - * C/usage-mainwindow.sgml: same. - * C/usage-setup.sgml: same. - * C/usage-sync.sgml: same. - -2000-05-07 Dan Winship <danw@helixcode.com> - - * Camel-Classes: sync - -2000-04-16 Aaron Weber <aaron@helixcode.com> - - * C/evo_book_0.1.sgml: new file (doc sgml) - - * C/ : New directory for doc sgml & graphics - -2000-03-05 Christopher James Lahey <clahey@helixcode.com> - - * white-papers/widgets/e-table.sgml: Added Miguel to the author - list for ETable. - -2000-03-03 Christopher James Lahey <clahey@helixcode.com> - - * white-papers/widgets/, white-papers/widgets/e-table.sgml: New - doc for the ETable widget. - - * ChangeLog: Created a ChangeLog file for the docs file and - integrated the individual ChangeLogs. - -2000-03-01 Dan Winship <danw@helixcode.com> - - * ibex.sgml: Ibex white paper - -2000-02-29 Federico Mena Quintero <federico@helixcode.com> - - * calendar.sgml: Sections for the calendar user agent and the - calendar client library. - -2000-02-29 Dan Winship <danw@helixcode.com> - - * camel.sgml: Reorg a bit more, make the <PRE> section narrower, - add more references to graphics (the graphics themselves are - still in beta), add a section on CamelStream. - -2000-02-28 Federico Mena Quintero <federico@helixcode.com> - - * calendar.sgml: Section for the personal calendar server. - -2000-02-28 Dan Winship <danw@helixcode.com> - - * camel.sgml: add Bertrand to authors, edit his additions - -2000-02-28 bertrand <bertrand@helixcode.com> - - * camel.sgml: add a blurb about camel offering - uniform interface. needs style and grammar corrections. - Talk about virtual folders. - Talk about lightweight messages - Talk about IMAP. - -2000-02-28 Dan Winship <danw@helixcode.com> - - * camel.sgml: Beginnings of a Camel white paper - -2000-02-25 Federico Mena Quintero <federico@helixcode.com> - - * calendar.sgml: New file for the Evolution calendaring white paper. - diff --git a/doc/Design b/doc/Design deleted file mode 100644 index 7b7cf6f821..0000000000 --- a/doc/Design +++ /dev/null @@ -1,201 +0,0 @@ - -The Evolution Project specification -Miguel de Icaza. - - -* Introduction - - Evolution is a project aiming at providing the free software - community with a professional, high-quality tool for managing - mail, appointments, tasks and other personal information - tools. - - We want to make Evolution a system that addresses our needs - (the free software development community) and we believe that - by addressing our needs, we will provide a system that will - scale in the years to come for other users that are just - starting to use computers and the internet. - - The main objectives of Evolution are to provide these powerful - features, and to make the user interface as pretty and - polished as possible. - - Evolution is a GNOME application and a number of auxiliary - CORBA servers that act as the storage backends. - - Evolution will copy the best user interface bits and the best - ideas and features found on contemporary groupware systems. - -* Evolution internals. - - Evolution can store its information locally (files for mail, - calendar and address book) or on a remote server (imap/pop, - cap, ldap). - - Given the importance of syncing in this modern PDA world, - the Evolution GUI acts as a client to the data repository. - The data repository is a GUI-less CORBA server called Wombat. - - Wombat provides a unified access system to the calendar and - addressbook data (doing mail is a bit hard, so we are leaving - this as a TODO item for now). - - Wombat's CORBA interfaces are notifier-based. This means that - CORBA requests sent to Wombat do not return values - inmediately, but rather than for Wombat requests the user has - to provide a CORBA object that will be notified of what - happened. - - Yes, that sounds hairy. It is actually pretty simple. It - basically means that you submit requests to Wombat, and a - callback is invoked in your code when the request has been - carried away. - - This enables a Palm to sync to the repository without having - the GUI for Evolution running. It also means that volunteers - will be able to write text-based and web-based versions of - Evolution (not me though :-). - -* Evolution as a platform - - Evolution is more than a client for managing the above - information: Evolution is a platform for building groupware - applications that use the above components to get their work done. - - To achieve this Evolution is designed to be scriptable, and it - exports its internals trough CORBA/Bonobo. It is implemented - as a collection of Bonobo containers and Bonobo components. - - There is a clean separation between the views (the user - interface) and the model (the view). The views that we are - writing are GNOME based, and they talk to the Wombat CORBA - server. - - Wombat takes care of notifications to the various clients for - the data. - -* The overall organization - - A bar similar to outlook provides shortcuts for accessing the - various resources managed by Evolution: mail folders, - contacts, tasks, journal entries, notes, messages and other - user-defined destinations. - -* User interface widgets - -** The ETable package - - This package provides a way of displaying and editing tables. - - Tables are displayed based on a TableColumn definition that - defines the layout used for the display. Table Columns can be - nested, and the package does grouping of information displayed - according to the criteria defined there. - - This is used in multiple places troughout evolution: it is - used for the Mail summary display, for the TODO display and - TODO new data entry and for the address book. - - Nesting in the address book can be performed on various - fields. For example, a first level of nesting could be - "Company" and a second level would be "Country" the result is - a 2-level tree that can be collapsed expanded and contains the - information sorted/grouped by those two criteria. - - The user interface for this will be copied from Outlook: the - possibility of adding and removing fields with drag and drop - as well as grouping using drag and drop. - -* The Mail system - -** The Mail sources - - The mail system will support 4 sources of mail: - - POP3 (transfer to a local file). - IMAP - Local mbox format in $MAIL. - Local mbox format that have other delivery points. - - On top of that, it will be possible to browse existing mbox - archives (and possibly other formats in the future, like - Mailbox and Maildir). - -** Storing the mail - - Mail that gets incorporated into the system is stored in mbox - format, and summary files are provided for quick access to the - files. No modifications to the file on disk is performed (I - am not quite sure about this, perhaps we want to add the - status flags and some method for adding metadata to the mail). - - Summary files are rebuilt on demand or rebuild if the mbox - file and the summary file have got out of sync. - - A Metadata system that will enable us to attach information to - a message will have to be designed and implemented (enabling - users to add annotations to mails, and special keywords and - flags in a per-message fashion). - -** Folders - - Michael Zucchi is working on a system that will let users - easily define rules for splitting their incoming mail into - physical folders. - - A further refinement to Folders are Virtual Folders. This - basically provides a powerful search and viewing facility for - mail. It works like this: when a mail is "incorporated" into - Evolution it is scanned and indexed. - - Then users can enter queries into Evolution that will search - the entire database of messages. - -** Virtual folders - - Virtual folders will enable users to read/browse their mail in - new ways: by specifying search criterias, these folders will - contain messages that match the criteria given. - - There is more information about this in the libcamel - directory. - - We will index all headers from a message, and possible the - contents of messages and keep those on a separate file, to - enable users to query their mail database. - -** Mail summary display - - The summary will be displayed using the ETable package, to - enable users to add a number of sorting criteria and various - display methods for the summary view. - - The Outlook methods for displaying will be present on the - system. - - Message threading will be supported in Evolution. - -** Message display engine - - We are going to be using a combination of - libcamel/limime/libjamie to parse messages and render them - into an HTML buffer. - -* The HTML engine - - The GtkHTML engine will be used to display messages, and will - be extended to support a number of features that we require: - internal handling of characters will be based on Unicode - -* The message composer - - Regular features found in composers will be added: connecting - the composer to the address book, support for drag and drop - for including attachments, editing the message, archiving - drafts and archiving messages sent. - - Ettore has been working on adding editing support to the - GtkHTML and he is working currently on a Bonobo component that - will provide a ready-to-use Bonobo control for embedding into - other applications. - diff --git a/doc/white-papers/calendar/calendar.sgml b/doc/white-papers/calendar/calendar.sgml deleted file mode 100644 index 2cb3132e2b..0000000000 --- a/doc/white-papers/calendar/calendar.sgml +++ /dev/null @@ -1,209 +0,0 @@ -<!doctype article PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!entity Evolution "<application>Evolution</application>"> -<!entity CUA "<acronym>CUA</acronym>"> -<!entity PCS "<acronym>PCS</acronym>"> -<!entity Bonobo "<application>Bonobo</application>"> -<!entity CORBA "<acronym>CORBA</acronym>"> -<!entity GTK "<acronym>GTK+</acronym>"> -]> - -<article class="whitepaper" id="calendar"> - - <artheader> - <title>&Evolution; Calendaring Framework</title> - - <authorgroup> - <author> - <firstname>Federico</firstname> - <surname>Mena Quintero</surname> - <affiliation> - <address> - <email>federico@helixcode.com</email> - </address> - </affiliation> - </author> - </authorgroup> - - <copyright> - <year>2000</year> - <holder>Helix Code, Inc.</holder> - </copyright> - - <abstract> - <para> - The &Evolution; groupware suite provides a framework for - developing calendaring applications, as well as a graphical - calendar client and a personal calendar server. This white - paper describes the architecture of the &Evolution; - calendaring framework. - </para> - </abstract> - </artheader> - - <!-- Introduction --> - - <sect1 id="introduction"> - <title>Introduction</title> - - <para> - Calendaring is an important part of a groupware suite. A - calendaring framework will allow a user to keep a personal - calendar and have several applications use it. Such - applications could be a graphical calendar client that the user - employs to schedule appointments and keep track of his time, a - <productname>Palm Pilot</productname> synchronization client, or - a simple alarm or reminder utility. A comprehensive calendaring - framework will also allow multiple users to schedule - appointments between each other; for example, a project director - may want to schedule a weekly meeting with the rest of the - project members, or a person who owns a large house may want to - schedule a big party with his friends. The attendees will then - want to reply with messages such as, “I will - attend”, or “I will attend only if the proposed time - is changed”. - </para> - - <para> - The &Evolution; groupware suite provides a framework for - developing calendaring applications, as well as a graphical - calendar client or calendar user agent (&CUA;) and a personal - calendar server (&PCS;). - </para> - - <para> - The following sections explain the basic calendaring framework, - the functions of the calendar user agent and the personal - calendar server, and the relationship between the two. - </para> - </sect1> - - <!-- Personal Calendar Server --> - - <sect1 id="pcs"> - <title>Personal Calendar Server</title> - - <para> - The personal calendar server (&PCS;) provides centralized - management and storage of a user's personal calendar. Multiple - clients can connect to the &PCS; simultaneously to query and - modify the user's calendar in a synchronized fashion. The main - features of the &PCS; are as follows: - </para> - - <formalpara> - <title>Storage</title> - - <para> - The &PCS; is responsible for loading and saving calendars. - Centralizing the loading and saving functionality allows - multiple clients to use the same calendar at the same time - without having to worry about each other. - </para> - </formalpara> - - <formalpara> - <title>Basic Queries</title> - - <para> - The &PCS; provides functions to do basic queries on a - calendar, for example, a client can ask the server for a list - of all the appointments in the calendar, or for all the data - for a specific appointment. - </para> - </formalpara> - - <formalpara> - <title>Recurrence and Alarm Queries</title> - - <para> - Clients can ask the &PCS; for a list of the appointments that - occur within a specified time range; for example a graphical - client that has a per-week view could ask the &PCS; for all - the appointments that occur in a particular week. This - includes multiple occurrences of a single recurring event; for - example, the object for “a 1-hour meeting that occurs on - every Tuesday and Thursday” is represented inside the - &PCS; as a single event with a recurrence rule. Similarly, - clients can ask the &PCS; for a list of events that have - alarms that trigger within a specified time range. - </para> - </formalpara> - - <formalpara> - <title>Notification of Changes</title> - - <para> - This is the most important function of the &PCS;, as it allows - multiple calendar clients to maintain a unified view of the - calendar between the server and themselves. When a client - asks the &PCS; to modify or remove an event, the &PCS; - notifies all the clients that are connected to it about the - change. The policy is that “the server is always - right”; clients can act as dumb views onto the - calendar's data and they will be notified by the &PCS; when - something changes. - </para> - </formalpara> - </sect1> - - <!-- Calenar User Agent --> - - <sect1 id="cua"> - <title>Calendar User Agent</title> - - <para> - A calendar user agent (&CUA;) is a program that lets a user - manipulate a calendar. &Evolution; provides an attractive, - graphical calendar client that communicates with the &Evolution; - personal calendar server. - </para> - - <para> - The &Evolution; calendar client just provides a view onto the - data that is stored and managed by the personal calendar server. - The calendar client does not perform direct manipulations on a - calendar's data; instead it offloads those requests to the - calendar server, which takes care of making the appropriate - modifications in the calendar and then notifies all the clients - about the changes. - </para> - </sect1> - - <!-- Calendar Client Library --> - - <sect1 id="client-lib"> - <title>Calendar Client Library</title> - - <para> - Communication between the personal calendar server and calendar - clients is defined by a set of &Bonobo; &CORBA; interfaces. - Clients can be written by implementing the client-side - <classname>Listener</classname> interface, which defines the - notification callbacks that the PCS uses to inform clients about - changes to the calendar. - </para> - - <para> - As a convenience for >K; programmers, &Evolution; also - includes a library which provides a - <classname>CalClient</classname> class which can be used for - communication with the personal calendar server. Objects of - this class automatically contact the PCS when they are created. - <classname>CalClient</classname> provides functions to request - changes in the calendar, and it also emits signals when it gets - notification about changes from the PCS. This makes it easy and - convenient to write calendar clients for &Evolution; using - >K;. - </para> - - <para> - The implementation of the <classname>CalClient</classname> class - simply wraps the &Evolution; &CORBA; interfaces for calendaring - with a familiar-looking >K; object. Calls to the - <classname>Listener</classname> interface get translated to - signal emissions from the <classname>CalClient</classname>, thus - shielding programmers from the details of the &CORBA; - interfaces. - </para> - </sect1> -</article> diff --git a/doc/white-papers/mail/camel.sgml b/doc/white-papers/mail/camel.sgml deleted file mode 100644 index a339909f54..0000000000 --- a/doc/white-papers/mail/camel.sgml +++ /dev/null @@ -1,339 +0,0 @@ -<!doctype article PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!entity Evolution "<application>Evolution</application>"> -<!entity Camel "Camel"> -]> - -<article class="whitepaper" id="camel"> - - <artheader> - <title>The &Camel; Messaging Library</title> - - <authorgroup> - <author> - <firstname>Dan</firstname> - <surname>Winship</surname> - <affiliation> - <address> - <email>danw@helixcode.com</email> - </address> - </affiliation> - </author> - - <author> - <firstname>Bertrand</firstname> - <surname>Guiheneuf</surname> - <affiliation> - <address> - <email>bertrand@helixcode.com</email> - </address> - </affiliation> - </author> - </authorgroup> - - <copyright> - <year>2000</year> - <holder>Helix Code, Inc.</holder> - </copyright> - - </artheader> - - <sect1 id="introduction"> - <title>Introduction</title> - - <para> - &Camel; is a generic messaging library. It is being used as the - back end for the mail component of &Evolution;. The name - "&Camel;" is an acronym; it refers to the fact that the - library is capable of going several days without food or water. - It means : Camel's Acronym Makes Everyone Laugh. - </para> - - <para> - &Camel;'s initial design is heavily based on Sun's - <trademark>JavaMail</trademark> API. It uses the Gtk+ object - system, and many of its classes are direct analags of JavaMail - classes. Its design has also been influenced by the features of - IMAP, and the limitations of the standard UNIX mbox mail store, - which set some of the boundaries on its requirements and - extensibility. - </para> - - <para> - &Camel; sees all message repositories as stores containing - folders. These folders in turn contain the messages the client - actually accesses. The use of such a unified interface allows - the client applications to be very extensible. &Camel; includes - an external provider mechanism which allows applications to - dynamically load and use protocols which were not available when - the application was initially written. - </para> - - <para> - The abstract store/folder mechanism is a powerful and versatile - way of accessing messages. No particular asumptions are made on - the client side, thus allowing new ways of managing the - messages. For example, the messages stored in the folders don't - necessarily have to share some common physical location. The - folder can be a purely virtual folder, containing only - references to the actual messages. This is used by the "vFolder" - provider, which allows you select messages meeting particular - criteria and deal with them as a group. - </para> - - <para> - In addition to these possibilities, &Camel; has full MIME - support. &Camel; MIME messages are lightweight objects - representing the MIME skeleton of the actual message. The data - contained in the subparts are never stored in memory except when - they are actually needed. The application, when accessing the - various MIME objects contained in the message (text parts, - attachments, embedded binary objects ...) asks &Camel; for a - stream that it can read data from. This scheme is particularly - useful with the IMAP provider. IMAP has strong MIME support - built-in, which allows &Camel; to download only the parts of - messages that it actually needs: attachments need not be - downloaded until they are viewed, and unnecessary - "multipart/alternative" parts will never be read off the server. - </para> - </sect1> - - <sect1 id="overview"> - <title>Overview</title> - - <graphic format="gif" fileref="camel"></graphic> - - <para> - To begin using &Camel;, an application first creates a - <classname>CamelSession</classname> object. This object is used - to store application defaults, and to coordinate communication - between providers and the application. - </para> - - <para> - A <classname>CamelProvider</classname> is a dynamically-loadable - module that provides functionality associated with a specific - service. Examples of providers are IMAP and SMTP. Providers - include subclasses of the various other &Camel; classes for - accessing and manipulating messages. - </para> - - <para> - <classname>CamelService</classname> is an abstract class for - describing a connection to a local or remote service. It - currently has two subclasses: <classname>CamelStore</classname>, - for services that store messages (such as IMAP servers and mbox - files), and <classname>CamelTransport</classname>, for services - that deliver messages (such as SMTP, or a local MTA). A provider - could also be both a store and a transport, as in the case of - NNTP. - </para> - - <para> - A <classname>CamelStore</classname> contains some number of - <classname>CamelFolder</classname> objects, which in turn - contain messages. A <classname>CamelFolder</classname> provides - a <classname>CamelFolderSummary</classname> object, which - includes details about the subject, date, and sender of each - message in the folder. The folder also includes the messages - themselves, as subclasses of <classname>CamelMedium</classname>. - </para> - - <para> - Email messages are represented by the - <classname>CamelMimeMessage</classname> class, a subclass of - <classname>CamelMedium</classname>. This class includes - operations for accessing RFC822 and MIME headers, accessing - subparts of MIME messages, encoding and decoding Base64 and - Quoted-Printable, etc. - </para> - - <para> - <classname>CamelTransport</classname> includes methods for - delivering messages. While the abstract - <function>CamelTransport::send</function> method takes a - <classname>CamelMedium</classname>, its subclasses may only be - able to deliver messages of specific - <classname>CamelMedium</classname> subclasses. For instance, - <classname>CamelSendmailTransport</classname> requires a - <classname>CamelMimeMessage</classname>, because it needs a - message that includes a "To:" header. A hypothetical - <classname>CamelNNTPTransport</classname> would need a - <classname>CamelNewsMessage</classname>, which would have a - "Newsgroups:" header. - </para> - - <para> - The content of messages are referred to using - <classname>CamelStream</classname> and its subclasses. In the - case of an mbox-based store, the - <classname>CamelStream</classname> would abstract the operation - of reading the correct section of the mbox file. For IMAP, - reading off the <classname>CamelStream</classname> might result - in commands being issued to the remote IMAP server and data - being read off a socket. - </para> - - <para> - The final major class in &Camel; is - <classname>CamelException</classname>, which is used to - propagate information about errors. Many methods take a - <classname>CamelException</classname> as an argument, which the - caller can then check if an error occurs. It includes both a - numeric error code which can be interpreted by the program, and - a text error message that can be displayed to the user. - </para> - </sect1> - - <sect1 id="classes"> - <title>Major Subcomponents</title> - - <sect2 id="store"> - <title>The Message Store</title> - - <para> - A <classname>CamelStore</classname> inherits the ability to - connect and authenticate to a service from its parent class, - <classname>CamelService</classname>. It then adds the ability - to retrieve folders. A store must contain at least one folder, - which can be retrieved with - <function>CamelStore::get_default_folder</function>. There are - also methods to retrieve the "top-level" folder (for - hieararchical stores), and to retrieve an arbitrary folder by - name. - </para> - - <para> - All <classname>CamelFolder</classname>s must implement certain - core operations, most notably generating a summary and - retrieving and deleting messages. A - <classname>CamelFolder</classname> must assign a permanently - unique identifier to each message it contains. Messages can - then be retrieved via - <function>CamelFolder::get_message_by_uid</function>. Alternately, - within a single mail-reading session, messages can be referred - to by their linear position within the store using - <function>CamelFolder::get_message_by_number</function>. - </para> - - <para> - Folders must also implement the - <function>get_parent_folder</function> and - <function>list_subfolders</function> methods. For stores that - don't allow multiple folders, they would return NULL and an - empty list, respectively. Stores that do allow multiple - folders will also define methods for creating and deleting - folders, and for moving messages between them (assuming the - folders are writable). - </para> - - <para> - Folders that support searching can define the - <function>search_by_expression</function> method. For mbox - folders, this is implemented by indexing the messages with the - ibex library and using that to search them later. For IMAP - folders, this uses the IMAP SEARCH command. Other folder types - might not be able to implement this functionality, in which - case users would not be able to do full-content searches on - them. - </para> - </sect2> - - <sect2 id="messages"> - <title>Messages</title> - - <para> - As mentioned before, messages are represented by subclasses of - <classname>CamelMedium</classname>. - <classname>CamelMedium</classname> itself is a subclass of - <classname>CamelDataWrapper</classname>, a generic class for - connecting a typed data source to a data sink. - <classname>CamelMedium</classname> adds the concept of message - headers versus message body. - (<classname>CamelDataWrapper</classname> has one other - important subclass, <classname>CamelMultipart</classname>, - which is used to provide separate access to the multiple - independent parts of a multipart MIME type.) - <classname>CamelMedium</classname>'s subclasses provide more - specialized handling of various headers: - <classname>CamelMimePart</classname> adds special handling for - the &ldquot;Content-*&rdquot; headers in MIME messages, and - its subclass <classname>CamelMimeMessage</classname> adds - handling for the RFC822 headers. - </para> - - <graphic format="gif" fileref="mimemessage"></graphic> - - <para> - Consider a message with two parts: a text part (in both plain - text and HTML), and an attached image: - - <programlisting> - - From: Dan Winship <danw@helixcode.com> - To: Matt Loper <matt@helixcode.com> - Subject: the Camel white paper - MIME-Version: 1.0 - Content-Type: multipart/mixed; - boundary="jhTYrnsRrdhDFGa" - - This is a multi-part message in MIME format. - --jhTYrnsRrdhDFGa - Content-Type: multipart/alternative; - boundary="sFSenbAFDSgDfg" - - --sFSenbAFDSgDfg - Content-Type: text/plain - - Hey, Matt - - Check out this graphic... - - -- Dan - - --sFSenbAFDSgDfg - Content-Type: text/html - - Hey, Matt<br> - <br> - Check out this graphic...<br> - <br> - -- Dan<br> - <br> - --sFSenbAFDSgDfg-- - - --jhTYrnsRrdhDFGa - Content-Type: image/png - Content-Transfer-Encoding: base64 - - F4JLw0ORrkRa8AwAMQJLAaI3UDIGsco9RAaB92... - --jhTYrnsRrdhDFGa-- - </programlisting> - - <para> - In &Camel;, this would be represented as follows: - </para> - - <graphic fileref="samplemsg"></graphic> - </sect2> - - <sect2 id="streams"> - <title>Streams</title> - - <para> - Streams are a generic data transport layer. Two basic stream - classes are <classname>CamelStreamFs</classname>, for - reading and writing files, and - <classname>CamelStreamMem</classname>, for reading from and - writing to objects that are already in memory. - </para> - - <para> - Streams can also be chained together. So a CamelMimePart - containing base64-encoded data can filter its output through - a CamelStreamB64. Other parts of the application that want - to read its data will never need to even realize that the - original data was encoded. - </para> - </sect2> - -</article> diff --git a/doc/white-papers/mail/ibex.sgml b/doc/white-papers/mail/ibex.sgml deleted file mode 100644 index dcb8f5ca4b..0000000000 --- a/doc/white-papers/mail/ibex.sgml +++ /dev/null @@ -1,158 +0,0 @@ -<!doctype article PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!entity Evolution "<application>Evolution</application>"> -<!entity Camel "Camel"> -<!entity Ibex "Ibex"> -]> - -<article class="whitepaper" id="ibex"> - - <artheader> - <title>Ibex: an Indexing System</title> - - <authorgroup> - <author> - <firstname>Dan</firstname> - <surname>Winship</surname> - <affiliation> - <address> - <email>danw@helixcode.com</email> - </address> - </affiliation> - </author> - </authorgroup> - - <copyright> - <year>2000</year> - <holder>Helix Code, Inc.</holder> - </copyright> - - </artheader> - - <sect1 id="introduction"> - <title>Introduction</title> - - <para> - &Ibex; is a library for text indexing. It is being used by - &Camel; to allow it to quickly search locally-stored messages, - either because the user is looking for a specific piece of text, - or because the application is contructing a vFolder or filtering - incoming mail. - </para> - </sect1> - - <sect1 id="goals"> - <title>Design Goals and Requirements for Ibex</title> - - <para> - The design of &Ibex; is based on a number of requirements. - - <itemizedlist> - <listitem> - <para> - First, obviously, it must be fast. In particular, searching - the index must be appreciably faster than searching through - the messages themselves, and constructing and maintaining - the index must not take a noticeable amount of time. - </para> - </listitem> - - <listitem> - <para> - The indexes must not take up too much space. Many users have - limited filesystem quotas on the systems where they read - their mail, and even users who read mail on private machines - have to worry about running out of space on their disks. The - indexes should be able to do their job without taking up so - much space that the user decides he would be better off - without them. - </para> - - <para> - Another aspect of this problem is that the system as a whole - must be clever about what it does and does not index: - accidentally indexing a "text" mail message containing - uuencoded, BinHexed, or PGP-encrypted data will drastically - affect the size of the index file. Either the caller or the - indexer itself has to avoid trying to index these sorts of - things. - </para> - </listitem> - - <listitem> - <para> - The indexing system must allow data to be added to the index - incrementally, so that new messages can be added to the - index (and deleted messages can be removed from it) without - having to re-scan all existing messages. - </para> - </listitem> - - <listitem> - <para> - It must allow the calling application to explain the - structure of the data however it wants to, rather than - requiring that the unit of indexing be individual files. - This way, &Camel; can index a single mbox-format file and - treat it as multiple messages. - </para> - </listitem> - - <listitem> - <para> - It must support non-ASCII text, given that many people send - and receive non-English email, and even people who only - speak English may receive email from people whose names - cannot be written in the US-ASCII character set. - </para> - </listitem> - </itemizedlist> - - <para> - While there are a number of existing indexing systems, none of - them met all (or even most) of our requirements. - </para> - </sect1> - - <sect1 id="implementation"> - <title>The Implementation</title> - - <para> - &Ibex; is still young, and many of the details of the current - implementation are not yet finalized. - </para> - - <para> - With the current index file format, 13 megabytes of Info files - can be indexed into a 371 kilobyte index file—a bit under - 3% of the original size. This is reasonable, but making it - smaller would be nice. (The file format includes some simple - compression, but <application>gzip</application> can compress an - index file to about half its size, so we can clearly do better.) - </para> - - <para> - The implementation has been profiled and optimized for speed to - some degree. But, it has so far only been run on a 500MHz - Pentium III system with very fast disks, so we have no solid - benchmarks. - </para> - - <para> - Further optimization (of both the file format and the in-memory - data structures) awaits seeing how the library is most easily - used by &Evolution;: if the indexes are likely to be kept in - memory for long periods of time, the in-memory data structures - need to be kept small, but the reading and writing operations - can be slow. On the other hand, if the indexes will only be - opened when they are needed, reading and writing must be fast, - and memory usage is less critical. - </para> - - <para> - Of course, to be useful for other applications that have - indexing needs, the library should provide several options, so - that each application can use the library in the way that is - most suited for its needs. - </para> - </sect1> -</article> diff --git a/doc/white-papers/widgets/e-table.sgml b/doc/white-papers/widgets/e-table.sgml deleted file mode 100644 index 5ff4faf2ae..0000000000 --- a/doc/white-papers/widgets/e-table.sgml +++ /dev/null @@ -1,279 +0,0 @@ -<!doctype article PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!entity Evolution "<application>Evolution</application>"> -<!entity ETable "<classname>ETable</classname>"> -<!entity ETableModel "<classname>ETableModel</classname>"> -<!entity ETableSimple "<classname>ETableSimple</classname>"> -<!entity ETableHeader "<classname>ETableHeader</classname>"> -<!entity ETableSpecification "<classname>ETableSpecification</classname>"> -<!entity ETableCol "<classname>ETableCol</classname>"> -]> - -<article class="whitepaper" id="e-table"> - - <artheader> - <title>The ETable Widget</title> - - <authorgroup> - <author> - <firstname>Chris</firstname> - <surname>Lahey</surname> - <affiliation> - <address> - <email>clahey@helixcode.com</email> - </address> - </affiliation> - </author> - <author> - <firstname>Miguel</firstname> - <surname>de Icaza</surname> - <affiliation> - <address> - <email>miguel@helixcode.com</email> - </address> - </affiliation> - </author> - </authorgroup> - - <copyright> - <year>2000</year> - <holder>Helix Code, Inc.</holder> - </copyright> - - </artheader> - - <sect1 id="introduction"> - <title>Introduction</title> - - <para> - &ETable; is a table widget on steroids. It is intended to provide - all the table functionality needed throughout &Evolution;, and - hopefully be general purpose enough to be used in other projects. - </para> - - <para> - &ETable; provides a lot of interactive control over the data in the - table. Without any work from the programmer, &ETable; provides - rearrangeable columns and editable data. When finished, &ETable; will - also provide, again with no programmer intervention, easy interactive - sorting and grouping. - </para> - - <para> - &ETable; gives you a great deal of functionality, flexibility, and - power. Most of this power is internal to the widget, but some of - the flexibility requires a bit of work by the programmer. - However, once you learn it, &ETable; is not very hard at all to - use. - </para> - - <para> - &ETable;'s power comes from the fact that it is fully - model/view/controller based. Various models are involved into - the process of rendering the information, and various views are - provided. The programmer has a wide range of options: from the - most finely hand-tuned table to a generic all-encompasing widget - that takes over most of tasks. It is up to the programmer: he - can use the simple to use &ETable; widget that takes care of - everything in a generic way, or he can use the various - components to roll his own tabular display. - </para> - - <para> - &ETable; ships with a standard set of information renderers: - strings, bitmaps, toggle-buttons, check-boxes, and multi-line - strings. But the programmer can write and implement his own - renderer for his information. This means that by default - &ETable; provides the basic display facilities that programmers - required, but they offer the programmer a complete freedom to - incorporate new cell renderers. - </para> - - </sect1> - - <sect1 id="model"> - <title>ETableModel</title> - - <para> - The data back end for the &ETable; is an &ETableModel;. The - &ETableModel is an abstract interface that acts as the - information repository for the various &ETable components. - </para> - - <para> - To use &ETable; you have to create a subclass of the abstract - &ETableModel; class. However, to save you the work of defining - a new <classname>GtkClass</classname> every time you use - &ETable, there is a predefined subclass of &ETableModel; called - &ETableSimple; which simply takes a list of function callbacks - to perform the various operations. - </para> - - </sect1> - - <sect1 id="columns"> - <title>Columns</title> - - <para> - There are two different meanings to the word "column". The first - is the model column (defined by the &ETableCol: object). A model - column describes how it maps to the column in the &ETableModel; - as well as containing information about its properties (name, - resizability, resize dimensions, and a renderer for this - specific columns). - </para> - - <para> - &ETable; distinguishes between a model column index, and a view - column index. The former reflects the column in which the data - is stored in the &ETableModel; The later represents the actual - location at which the column is being displayed in the screen. - </para> - - <para> - Each view column index corresponds to a specific model column, - though a model column may have any number of view columns - associated with it (including zero). For example the same - column might be rendered twice, or the data from one column - could be used to display different bits of information - </para> - - <para> - The view column does not necessarily depend on only one model - column. In some cases, the view column renderer can be given a - reference to another model column to get extra information about - its display. For example, a mail program could display deleted - messages with a line through them by creating a model column - with no corresponding view column that told whether or not the - message is deleted, and then having the text column - strikethrough the display if the invisible column had a value - corresponding to "deleted". - </para> - - <para> - The view column also specifies a few other pieces of - information. One piece of information is the renderer. &ETable; - provides a number of renderers to choose from, or you can write - your own. Currently, there are renderers for text, image sets, - and checkboxes. - </para> - - <para> - The view column also includes information about the header. - There are two types of headers: text, and pixbuf. The first - allows you to specify a string which is rendered in the header. - The second allows you to specify an image to copy into the - header. - </para> - </sect1> - - <sect1 id="header"> - <title>Header</title> - - <para> - The &ETableHeader; represents the header information for the - table. The &ETableHeader; is used in two different ways. The - first is the in the <structfield>full_header</structfield> - element of an &ETable;. This is the list of possible columns in - the view. You add each of your columns to this &ETableHeader; - and then pass it into the &ETable;. - </para> - - <para> - The second use is completely internal. &ETable; uses another - &ETableHeader; to store the actual displayed columns. Many of - the &ETableHeader; functions are for this purpose. The only - functions that users of the library should need to use are - <function>e_table_header_new</function> and - <function>e_table_header_add_col</function>. - </para> - </sect1> - - <sect1 id="layout"> - <title>Layout Specification</title> - - <para> - &ETable; uses an &ETableSpecification; to layout the columns of - the widget. The &ETableSpecification; is specified as XML data - passed into the &ETable; as a string. - </para> - - <para> - The most powerful part of the &ETableSpecification; is that when - finished, &ETable; will allow you to get a copy of an - &ETableSpecification; that describes the current view of the - tree. This allows the developer to save the current view so that - next time the user opens this table, they find it in exactly the - state that they left it. - </para> - - <para> - The XML specification allows for a number of things. First, it - allows you to pick a set of default columns to be shown. Thus, - even if you had hundreds of pieces of data, you could choose to - only display a few that fit on the screen by default. - </para> - - <para> - The second major thing that the &ETableSpecification; allows you - to specify is the column grouping and sorting. &ETable; has a - powerful mechanism for allowing the user to choose columns to - group by, thus allowing multiple columns of sorting, as well as - visual grouping of similar elements and interactive selection of - what data to display. - </para> - - <para> - The grouping in &ETableSpecification; is specified as a - hierarchy of columns to group by. Each level of the hierarchy - lets you sort by a particular column, either ascending or - descending. All levels except the last cause the canvas to group - by the given column. - </para> - - <para> - An example &ETableSpecification; follows. - </para> - - <programlisting> - <ETableSpecification> - <columns-shown frozen_columns="2"> - <column> 0 </column> - <column> 1 </column> - <column> 2 </column> - <column> 3 </column> - <column> 4 </column> - </columns-shown> - <grouping> - <group column="3" ascending="1"> - <group column="4" ascending="0"> - <leaf column="2" ascending="1"/> - </group> - </group> - </grouping> - </ETableSpecification> - </programlisting> - - <para> - This example has 5 columns which are initially in order. It has - 2 levels of grouping. The first is grouped by the 4th column - (all indexes are 0 based) and sorts those groups in ascending - order. Inside those groups, the data is grouped by the fifth - column and sorted in descending order of the fifth column. - Finally, the data in those groups is sorted by the third column - in ascending order. Due to the "frozen_columns" attribute on the - columns-shown element, the user will not be - able to rearrange the first two columns. They will always be the - first two. - </para> - </sect1> - - <sect1 id="conclusion"> - <title>Conclusion</title> - - <para> - All in all, &ETable; is a very powerful widget. Once you learn - to use it, you have access to a vast amount of power requiring a - comparatively small amount of work. - </para> - </sect1> -</article> |
