diff options
Diffstat (limited to 'doc')
68 files changed, 0 insertions, 10030 deletions
diff --git a/doc/.cvsignore b/doc/.cvsignore deleted file mode 100644 index 282522db03..0000000000 --- a/doc/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/C/.cvsignore b/doc/C/.cvsignore deleted file mode 100644 index cba1534920..0000000000 --- a/doc/C/.cvsignore +++ /dev/null @@ -1,4 +0,0 @@ -Makefile -Makefile.in -evolution-guide -evolution-guide.junk diff --git a/doc/C/Makefile.am b/doc/C/Makefile.am deleted file mode 100644 index 0d02ac056f..0000000000 --- a/doc/C/Makefile.am +++ /dev/null @@ -1,51 +0,0 @@ -evolution_helpdir = $(datadir)/gnome/help/evolution/C - -SGML_FILES = \ - apx-authors.sgml \ - apx-bugs.sgml \ - apx-fdl.sgml \ - apx-gloss.sgml \ - config-prefs.sgml \ - config-setupassist.sgml \ - config-sync.sgml \ - evolution-guide.sgml \ - preface.sgml \ - usage-calendar.sgml \ - usage-contact.sgml \ - usage-mail.sgml \ - usage-mainwindow.sgml \ - usage-sync.sgml - - -EXTRA_DIST = \ - $(SGML_FILES) - -all: evolution-guide - -evolution-guide: $(SGML_FILES) - -db2html evolution-guide.sgml - -dist-hook: - mkdir $(distdir)/evolution-guide - -cp evolution-guide/*.html evolution-guide/*.css \ - $(distdir)/evolution-guide - mkdir $(distdir)/fig - -cp fig/*.png $(distdir)/fig - -install-data-local: evolution-guide - $(top_srcdir)/mkinstalldirs $(DESTDIR)$(evolution_helpdir)/fig - -for file in $(srcdir)/evolution-guide/*.html $(srcdir)/evolution-guide/*.css; do \ - basefile=`basename $$file`; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(evolution_helpdir)/$$basefile; \ - done - -for file in $(srcdir)/fig/*.png; do \ - basefile=`basename $$file`; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(evolution_helpdir)/fig/$$basefile; \ - done - -evolution.ps: evolution.sgml - -db2ps $< - -evolution.rtf: evolution.sgml - -db2rtf $< - diff --git a/doc/C/apx-authors.sgml b/doc/C/apx-authors.sgml deleted file mode 100644 index e064276be3..0000000000 --- a/doc/C/apx-authors.sgml +++ /dev/null @@ -1,74 +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> 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>danw@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>. 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>) and Kevin Breit - (<email>battery841@mypad.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 e7a501acba..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 use the GNOME - <application>Bug Report Tool</application> (known as - <command>bug-buddy</command> at the command line) if you find one - we have not listed. - </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 8b49729cfc..0000000000 --- a/doc/C/apx-fdl.sgml +++ /dev/null @@ -1,678 +0,0 @@ -<appendix id="fdl"> - <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 55ab3ed8a1..0000000000 --- a/doc/C/apx-gloss.sgml +++ /dev/null @@ -1,284 +0,0 @@ -<glossary id="glossary"> - - <title>Glossary</title> - - <glossentry id="attachment"> - <glossterm>Attachment</glossterm> - <glossdef> - <para> - Any file sent along with an email. Attachments may be embedded in - a message or appended to it. - </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> - -<!-- Removed pending decision on names - <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="emoticon"> - <glossterm>Emoticon</glossterm> - <glossdef> - <para> - Also called smileys, emoticons are the little sideways faces made - of colons and parentheses which people use to convey emotion in email. - Examples: :-) or ;( . - </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. <application>Evolution</application> can download - executable attachments, but before they can be run, the files must - be marked as executable with a shell or file manager. This - security precaution prevents the automatic or accidental execution - of malicious programs. - </para> - </glossdef> - </glossentry> - - <glossentry id="filter"> - <glossterm>Filter</glossterm> - <glossdef> - <para> - Within <application>Evolution</application>, a filter is a method - of sorting mail automatically. You can create filters to perform - one or more actions on a message that meets any (or all) of a wide - range of criteria. - </para> - </glossdef> - </glossentry> - - <glossentry id="forward"> - <glossterm>Forward</glossterm> - <glossdef> - <para> - 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 which helps groups - of people work together. Typically, a groupware application will - have several 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="ldap"> - <glossterm>LDAP</glossterm> - <glossdef> - <para> - LDAP is a protocol which allows a client to search through a large database - of addresses, phone numbers, and people, as an alternative to a physical - phone book. - </para> - </glossdef> - </glossentry> - - <glossentry id="mail-client"> - <glossterm>Mail Client</glossterm> - <glossdef> - <para> - A mail client is the application with which a person reads and - sends e-mail. Its counterparts are the various types of mail - servers, which handle user authentication and direct messages from - sender to recipient. - </para> - </glossdef> - </glossentry> - - - <glossentry id="minicard"> - <glossterm>Minicard</glossterm> - <glossdef> - <para> - A format for the display of contact data. Similar in appearance - to a small business card. - </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="signature"> - <glossterm>Signature</glossterm> - <glossdef> - <para> - Signatures allow a user to specify a message to place at the bottom of - every email sent. A signature can be anything from a favorite quote to - a link to a webpage. - </para> - </glossdef> - </glossentry> - - - <glossentry id="spam"> - <glossterm>Spam</glossterm> - <glossdef> - <para> - Spam: useless, unwanted e-mail. Spam normally comes in forms of - chain-letters and advertisements for unscrupulous websites or - services. Messages that are merely useless are called - "opt-in newsletters." - </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/apx-gpl.sgml b/doc/C/apx-gpl.sgml deleted file mode 100644 index 7c7e4cd0f7..0000000000 --- a/doc/C/apx-gpl.sgml +++ /dev/null @@ -1,414 +0,0 @@ -<appendix id="gpl"> - <title>GNU GENERAL PUBLIC LICENSE</title> - <subtitle>Version 2, June 1991</subtitle> - - -<para> - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. -</para> -<sect1> -<title>Preamble</title> -<para> - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. -</para> -<para> - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. -</para> -<para> - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. -</para> -<para> - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. -</para> -<para> - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. -</para> -<para> - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. -</para> -<para> - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. -</para> -<para> - The precise terms and conditions for copying, distribution and -modification follow. -</para> - -</sect1> - -<sect1> -<title> GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</title> -<para> - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". -</para> -<para> -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. -</para> -<para> - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. -</para> -<para> -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. -</para> -<para> - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: -</para> -<para> - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. -</para> -<para> - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. -</para> -<para> - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) -</para> -<para> -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. -</para> -<para> -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. -</para> -<para> -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. -</para> -<para> - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: -</para> -<para> - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, -</para> -<para> - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, -</para> -<para> - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) -</para> -<para> -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. -</para> -<para> -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. -</para> -<para> - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program 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> -<para> - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. -</para> -<para> - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. -</para> -<para> - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. -</para> -<para> -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. -</para> -<para> -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. -</para> -<para> -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. -</para> -<para> - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. -</para> -<para> - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public 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. -</para> -<para> -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. -</para> -<para> - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. -</para> -</sect1> -<sect1> -<title>NO WARRANTY</title> -<para> - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. -</para> -<para> - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. -</para> -<para> - END OF TERMS AND CONDITIONS -</para> -</sect1> - <sect1> - <title>How to Apply These Terms to Your New Programs</title> -<para> - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. -</para> -<para> - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. -</para> -<para> - <one line to give the program's name and a brief idea of what it does.> -Copyright (C) < year> <name of author> -</para> -<para> - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. -</para> -<para> - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. -</para> -<para> - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -</para> -<para> - -Also add information on how to contact you by electronic and paper mail. -</para> -<para> -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: -</para> -<para> - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. -</para> -<para> -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. -</para> -<para> -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: -</para> -<para> - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. -</para> -<para> - <signature of Ty Coon>, 1 April 1989 - Ty Coon, President of Vice -</para> -<para> -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. -</para> -</sect1> -</appendix> - - - - - - - - - diff --git a/doc/C/config-prefs.sgml b/doc/C/config-prefs.sgml deleted file mode 100644 index e0f6dd0297..0000000000 --- a/doc/C/config-prefs.sgml +++ /dev/null @@ -1,570 +0,0 @@ -<!-- <!DOCTYPE Chapter PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> --> - -<chapter id="config-prefs"> - - <title>Advanced Configuration</title> - <para> - Perhaps your mail server has changed names. Perhaps you've - grown tired of a certain layout for your appointments. - Whatever the reason, you want to change your - <application>Evolution</application> settings. This chapter - will tell you how to do just that. - </para> - - <sect1 id="config-prefs-mail"> - <title>Mail Settings</title> - <para> - To change your mail settings, first go to your - <interface>Inbox</interface>. Then select <guimenuitem>Mail - Settings</guimenuitem> from the <guimenu>Tools</guimenu> menu. - This will open the <interface>mail preferences - window</interface>, illustrated in <xref - linkend="config-prefs-mail-fig">. Mail Preferences are - separated into several categories: - <variablelist> - <varlistentry> - <term><guilabel>Identity</guilabel></term> - <listitem> - <para> - This allows you to set - your name, email address, and other information. The - default values are the ones found on your system account. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Sources</guilabel></term> - <listitem> - <para> - Set your mail-checking protocols and servers here. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Sources</guilabel></term> - <listitem> - <para> - Set your mail-checking protocols and servers here. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>News Servers</guilabel></term> - <listitem> - <para> - Specify your News Server preferences here. - </para> - </listitem> - </varlistentry> - </variablelist> - -<!-- THE FOLLOWING MAY BE REINSTATED: - 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> - - <!-- ==============Figure===================== --> - <figure id="config-prefs-mail-fig"> - <title>Preferences Dialog</title> - <screenshot> - <screeninfo>Setting mail preferences</screeninfo> - <graphic fileref="fig/config-mail" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - <!-- ==============End of Figure================--> - - - <sect2 id="config-prefs-mail-identity"> - <title>Identity Settings</title> - <para> - If you have only one email address, or use automatic - forwarding to funnel multiple addresses to one account, then - you will only need to configure one identity. You may, - however, want more that one. To alter an identity, click on - it in the <guilabel>Identity</guilabel> tab of the - <interface>Preferences</interface> window, and then click - <guibutton>Edit</guibutton>. To add a new identity, simply - click <guibutton>Add</guibutton>. - </para> - - <para> - In either case, you'll be presented with a dialog box with - four fields: - <itemizedlist> - <listitem> - <para> - <guilabel>Full Name:</guilabel> by default, this is the - same name as the full name described in your user - account on your computer. You can select another if you - wish. - </para> - </listitem> - <listitem> - <para> - <guilabel>Email address:</guilabel> Enter your email - address in this space. - </para> - </listitem> - <listitem> - <para> - <guilabel>Organization:</guilabel> If you send email as - a representative of a company or other organization, - enter its name here. - </para> - </listitem> - <listitem> - <para> - <guilabel>Signature file:</guilabel> You may choose a - small text file to be appended to every message that you - send. Typically, signature files include address or - other contact information, or a favorite quotation. - They should not be more than three lines long. - </para> - </listitem> - </itemizedlist> - - </para> - </sect2> - - <sect2 id="config-prefs-mail-network"> - <title>Network Settings</title> - <para> - In order to send mail 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 program, you can almost certainly use the same - settings as you did with that program. Select the - <guibutton>Sources</guibutton> tab in the - <interface>Preferences</interface> window to tell - <application>Evolution</application> where you want to get - your mail, and click <guibutton>Transports</guibutton> to - determine how you want to send your mail. - </para> - - <sect3 id="config-prefs-network-sources"> - <title>Mail Sources</title> - <para> - The <interface>Mail Sources</interface> tab allows you to - edit, add, or delete methods of retrieving mail from - servers. Clicking on <guibutton>Add</guibutton> or - <guibutton>Edit</guibutton> will bring up a dialog box to - offer you the following options: - <variablelist> - <varlistentry> - <term><guilabel>Mail source type:</guilabel></term> - <listitem> - <para> - Select from IMAP, POP or Unix-style - <filename>mbox</filename> files. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> <guilabel>Server:</guilabel></term> - <listitem> - <para> - Enter the name of your mail server in this field. - For example: - <userinput>mail.mycompany.com</userinput> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Username:</guilabel></term> - <listitem> - <para> - Enter your user name here. Eva Lucianne Tester's - user name is <userinput>eltester</userinput>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Authentication:</guilabel></term> - <listitem> - <para> - Your system administrator will know which type of - authentication your system requires. - <application>Evolution</application> can also detect - what sorts of authentication are available once it - knows where to find the server. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Test values before continuing</guilabel></term> - <listitem> - <para> - If this box is checked, - <application>Evolution</application> will attempt to - make sure that all the other entries in the dialog - window are correct. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </sect3> - <sect3 id="config-prefs-mail-network-transports"> - <title>Transports</title> - <para> - The <interface>Transports</interface> tab lets you set how - you will send mail. Evolution currently supports two mail - transport options: <guilabel>SMTP</guilabel>, which uses a - remote mail server, and <guilabel>sendmail</guilabel>, - which uses the <application>sendmail</application> program - on your local system. <application>Sendmail</application> - is more difficult to configure, but offers more flexibility - than plain <systemitem>SMTP</systemitem>. - </para> - <para> - To use <guilabel>SMTP</guilabel>, you'll need to enter the - name of your SMTP server, which should look like: - <userinput>smtp.isp.net</userinput>. - </para> - <para> - <application>Evolution</application> can - attempt to determine if you have entered the right server - name. To have it do so, check the box labelled - <guilabel>Test these values before continuing</guilabel> - before you click <guibutton>OK</guibutton>. - </para> - </sect3> - </sect2> - <sect2 id="config-prefs-network-news"> - - <!-- WHY is this in the MAIL config section? WHY is this UI SOOOO bad?--> - - <title>News Servers</title> - <para> - When you first select the <guilabel>News - Servers</guilabel> tab, you will see a blank box with - three familiar buttons on the right: - <guibutton>Add</guibutton>, <guibutton>Edit</guibutton>, - and <guibutton>Delete</guibutton>. - </para> - <para> - Click <guibutton>Add</guibutton> to add a news server; you - will be prompted for its name. Enter the name, click - <guibutton>OK</guibutton>, and you're done. (FIXME, this needs work). - </para> - </sect2> - - <sect2 id="config-prefs-mail-other"> - <title>Other Mail Preferences</title> - <para> - Not everything fits neatly into categories. This tab - contains some miscellaneous configurations that don't have - too much to do with each other. - <variablelist> - <varlistentry> - <term> - <guilabel>Send messages in HTML format</guilabel> - </term> - <listitem><para> - If you check this box, you will send - messages as HTML by default. If you leave it unchecked, your - messages will be sent without HTML formatting unless you select - <menuchoice> <guimenu>Format</guimenu> <guimenuitem>HTML</guimenuitem> - </menuchoice> in the message composer. - See <xref linkend="usage-mail-getnsend-send-html"> - for more information about HTML mail. - </para></listitem> - </varlistentry> - <varlistentry> - <term> - <guilabel>Folder Format</guilabel> - </term> - <listitem> <para> By default, - <application>Evolution</application> saves its mail - in the - <systemitem><filename>mbox</filename></systemitem> - format. You can switch to the - <systemitem><filename>mh</filename></systemitem> - format if you like. Note that this is an advanced - feature and may cause you to lose some messages, so - you should probably make a backup of your - <systemitem><filename>evolution</filename></systemitem> - directory first. In addition, it will take quite - some time if you have a large mailbox. - </para></listitem> - </varlistentry> - </variablelist> - </para> - </sect2> - </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. While - looking at your calendar, select - <guimenuitem>Preferences</guimenuitem> from the - <guimenu>Edit</guimenu> menu. This will open up the - <interface>Preferences</interface> window. It contains four - tabs: <guilabel>Time display</guilabel>, - <guilabel>Colors</guilabel>, <guilabel>To Do List</guilabel> - and <guilabel>Alarms</guilabel>. The <interface>calendar - preferences window</interface> is illustrated in <xref - linkend="config-prefs-cal-fig">. - - <!-- ==============Figure===================== --> - <figure id="config-prefs-cal-fig"> - <title>Calendar Preferences Dialog</title> - <screenshot> - <screeninfo>If this worked on my job as well as my calendar...</screeninfo> - <graphic fileref="fig/config-cal" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - <!-- ==============End of Figure================--> - </para> - - <sect2 id="config-prefs-cal-time"> - <title>Time Display Settings</title> - <para> - The <guilabel>Time display</guilabel> tab lets you set the - following: - <variablelist> - <varlistentry> - <term>Time format</term> - <listitem> - <para>You may choose between twelve-hour (AM/PM) and - twenty-four hour time formats here by clicking the - appropriate radio button. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Weeks start on</term> - <listitem> - <para>You can set weeks to start on Sunday or on Monday.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>Day range</term> - <listitem> - <para> - When does your work day start, and when does it end? - In the day and week views, - <application>Evolution</application> displays all the - hours in the range you select here, even if there are - no appointments for those times. Of course, you can - still schedule an appointment outside of these hours, - and if you do, the display will be extended to show - it. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </sect2> - <sect2 id="config-prefs-cal-color"> - <title>Calendar Colors</title> - <para> - The <interface>colors tab</interface> allows you to decide - what color your calendar will be. The tab consists of a - sample calendar on the right and a list of ten items that can - be colored in different ways. If you click on the color - button to the right of each item, you will bring up a - color-selector window where you can choose to alter that - color. By clicking <guibutton>OK</guibutton> in the color - selection dialog, you can see the results of the color on the - sample calendar. - </para> - <para>The display elements whose color you can set are: - - <itemizedlist> - <listitem> - <para> - <guilabel>Outline:</guilabel> The lines between days - and at the top of the display. - </para> - </listitem> - - <listitem> - <para> <guilabel>Headings:</guilabel> Text color for day - and month names and other headings. - </para> - </listitem> - - <listitem> - <para> <guilabel>Empty days:</guilabel> This is the - background color for any time slots in which you have no appointments. - </para> - </listitem> - - <listitem> - <para> - <guilabel>Appointments:</guilabel> This is the - background color for any time slots in which you have appointments. - </para> - </listitem> - - <listitem> - <para> <guilabel>Highlighted day:</guilabel> The - background color for a selected time slot. - </para> - </listitem> - - - <listitem> - <para> - <guilabel>Day numbers:</guilabel> Text color for date numbers. - </para> - </listitem> - - - <listitem> - <para> - <guilabel>Current day's number:</guilabel> Text color for today's date. - </para> - </listitem> - - <listitem> - <para> <guilabel>To-Do item that is not yet - due:</guilabel> Text color for To-Do list items that are - not yet due. (Or maybe background color? find out!) - </para> - </listitem> - - - <listitem> - <para> <guilabel>To-Do item that is due today:</guilabel> - Text color for today's tasks. - </para> - </listitem> - - <listitem> - <para> <guilabel>To-Do item that is overdue:</guilabel> - Text color for overdue tasks. - </para> - </listitem> - - </itemizedlist> - </para> - </sect2> - - <sect2 id="config-prefs-cal-todo"> - <title>To Do List Settings</title> - <para> - You can choose what information the To Do list displays and the - way it is displayed. The two areas of the <interface>To Do - List</interface> tab offer several options each: - <variablelist> - <varlistentry> - <term>Show on To Do List</term> - <listitem> - <para> - This box contains three items. If you select the - check boxes next to them, that information will appear - in the To Do list for each task it contains: - <itemizedlist> - <listitem> - <para><guilabel>Due Date</guilabel></para> - </listitem> - <listitem> - <para><guilabel>Time Until Due</guilabel></para> - </listitem> - <listitem> - <para><guilabel>Priority</guilabel></para> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Style Options</term> - <listitem> - <para> - Select among the following checkboxes to determine - how your To Do list will look: - <itemizedlist> - <listitem> - <para><guilabel>Highlight overdue items</guilabel></para> - </listitem> - <listitem> - <para><guilabel>Highlight items due today</guilabel></para> - </listitem> - <listitem> - <para><guilabel>Highlight not yet due items</guilabel></para> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </sect2> - - <sect2 id="config-prefs-cal-alarms"> - <title>Alarms Settings</title> - <para> - The <interface>alarms tab</interface> enables you to select from three boxes: - <itemizedlist> - <listitem> - <para><guilabel>Beep on display alarms</guilabel>: select - this box to have <application>Evolution</application> beep - at you for any alarms you have set. If you leave this box - unchecked, <application>Evolution</application> will only - alert you to events by opening a dialog box. - </para> - </listitem> - <listitem> - <para><guilabel>Audio alarms timeout after: </guilabel> - Select this button to have the beeping stop automatically - after a certain number of seconds. </para> - </listitem> - <listitem> - <para><guilabel>Enable snoozing for:</guilabel> If you - would like to have the option to tell - <application>Evolution</application> to repeat an alarm in - a few minutes, select this button and decide how long - you'd like it to wait. - </para> - </listitem> - </itemizedlist> - </para> - </sect2> - - - </sect1> - - <sect1 id="config-prefs-general"> - <title>General Preferences</title> - <para> - Additional configuration options will be covered here, as - they become available. - </para> - </sect1> -</chapter> - - - - - - diff --git a/doc/C/config-setupassist.sgml b/doc/C/config-setupassist.sgml deleted file mode 100644 index 52ca546b9a..0000000000 --- a/doc/C/config-setupassist.sgml +++ /dev/null @@ -1,159 +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> - - <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 assistant</interface> will pop up to help you with your - email preferences. If you don't plan to use email, or if - you'd rather deal with your email preferences later, click - <guibutton>Cancel</guibutton>. - </para> - <para> - The setup assistant (sometimes called a - <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 assistant is - pictured in <xref linkend="usage-setup-fig">. - -<!-- ==============Figure=================================== --> -<!-- druid-pic should eventually become assistant-pic --> - - <figure id="usage-setup-fig"> - <title>Mail Setup Assistant</title> - <screenshot> - <screeninfo>Evolution Main Window</screeninfo> - <graphic fileref="fig/mail-druid-pic" format="png" srccredit="Kevin Breit"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure=================================== --> - - - - The assistant will ask you for the following information: - <variablelist> - - <varlistentry> - <term> <guilabel>Name:</guilabel> </term> - <listitem> <para>Your - full name: eg. Eva Lucianne Tester </para></listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Email address:</guilabel></term> - <listitem><para> - Your email address: eg. eltester@helixcode.com - </para></listitem> - </varlistentry> - - <varlistentry> - <term> <guilabel>Organization:</guilabel></term> - <listitem> - <para> - <guilabel>Organization:</guilabel> Any organization you - represent. Leave this blank if you wish. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Signature File:</guilabel></term> - <listitem> - <para> - A text file appended to any email you send. A signature - file typically consists of your name and email address, - or a quotation you like. It should be fewer than four - lines of text. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> <guilabel>Mail source type:</guilabel></term> - <listitem> - <para> - <application>Evolution</application> supports three mail - sources: POP servers, the most common email server type; - IMAP, which stores mail remotely and allows access from - multiple locations, and UNIX-style - <filename>mbox</filename> files. Ask your system - administrator which one you use. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> <guilabel>Server:</guilabel></term> - <listitem> - <para> - This should be the name of your mail server: it should - look something like: - <userinput>mailserver.organization.org</userinput>. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Username:</guilabel></term> - <listitem> - <para> - Normally, 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> - </varlistentry> - - <varlistentry> - <term><guilabel>Authentication:</guilabel></term> - <listitem> - <para> - 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> - </varlistentry> - - <varlistentry> - <term><guilabel>Mail Transport:</guilabel></term> - <listitem> - <para> - This is the mail sending protocol you will want to use. - <application>Evolution</application> supports both SMTP - and <application>sendmail</application>. - </para> - </listitem> - </varlistentry> - </variablelist> - </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/evolution-guide.sgml b/doc/C/evolution-guide.sgml deleted file mode 100644 index 59b50120b9..0000000000 --- a/doc/C/evolution-guide.sgml +++ /dev/null @@ -1,132 +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-NOTES SYSTEM "usage-notes.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 APX-GLOSS SYSTEM "apx-gloss.sgml"> -<!ENTITY APX-BUGS SYSTEM "apx-bugs.sgml"> -<!ENTITY APX-AUTHORS SYSTEM "apx-authors.sgml"> -<!ENTITY APX-FDL SYSTEM "apx-fdl.sgml"> -<!ENTITY APX-GPL SYSTEM "apx-gpl.sgml"> - -]> - - -<!-- Almost every chapter is an entity. Files, Chapter id's, and entity names correspond. APX is for appendix. --> -<book id="index"> - <bookinfo> - <title>A User's Guide to Evolution</title> - <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> - Permission is granted to copy, distribute and/or modify this - document under the terms of the <citetitle>GNU Free - Documentation License</citetitle>, (FDL) Version 1.1 or any later - version published by the Free Software Foundation with no - Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. - </para> - <para> - The software described by this document falls under the - <citetitle>GNU General Public License</citetitle>, or GPL. - </para> - <para> - The licenses are included with this document in <xref - linkend="fdl">, and <xref linkend="gpl">; you may also obtain - a copy from the Free Software Foundation by visiting <ulink - type="http" url="http://www.fsf.org">their Web site</ulink> or - by writing to: Free Software Foundation, Inc., 59 Temple Place - - Suite 330, Boston, MA 02111-1307, USA. - </para> - <para> - Many of the names used by companies to distinguish their - products and services are claimed as trademarks. Where those - names appear in any GNOME documentation, and those trademarks - are made aware to the members of the GNOME Documentation - Project, the names have been printed in caps or initial caps. - </para> - - </legalnotice> - - <releaseinfo> - This is version 0.4 of the Evolution manual, describing version - 0.3.1 of Evolution. - </releaseinfo> - - </bookinfo> - - &PREFACE; - - <part id="usage"> - <title>Using Evolution</title> - <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-NOTES; - &USAGE-SYNC; - - </part> - <part id="config"> - <title>Configuring and Managing Evolution</title> - <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> - &APX-GLOSS; - &APX-BUGS; - &APX-AUTHORS; - &APX-FDL; - &APX-GPL; - -</book> - - - - - - - - - - - diff --git a/doc/C/fig/calendar.png b/doc/C/fig/calendar.png Binary files differdeleted file mode 100644 index 47354813a2..0000000000 --- a/doc/C/fig/calendar.png +++ /dev/null diff --git a/doc/C/fig/config-cal.png b/doc/C/fig/config-cal.png Binary files differdeleted file mode 100644 index e124196279..0000000000 --- a/doc/C/fig/config-cal.png +++ /dev/null diff --git a/doc/C/fig/config-mail.png b/doc/C/fig/config-mail.png Binary files differdeleted file mode 100644 index ef270858f7..0000000000 --- a/doc/C/fig/config-mail.png +++ /dev/null diff --git a/doc/C/fig/contact.png b/doc/C/fig/contact.png Binary files differdeleted file mode 100644 index 1610e278a4..0000000000 --- a/doc/C/fig/contact.png +++ /dev/null diff --git a/doc/C/fig/filter-new-fig.png b/doc/C/fig/filter-new-fig.png Binary files differdeleted file mode 100644 index 4c612ce5fc..0000000000 --- a/doc/C/fig/filter-new-fig.png +++ /dev/null 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 0ff712efa5..0000000000 --- a/doc/C/fig/mainwindow-pic.png +++ /dev/null diff --git a/doc/C/fig/vfolder-createrule-fig.png b/doc/C/fig/vfolder-createrule-fig.png Binary files differdeleted file mode 100644 index 571a487ba4..0000000000 --- a/doc/C/fig/vfolder-createrule-fig.png +++ /dev/null diff --git a/doc/C/preface.sgml b/doc/C/preface.sgml deleted file mode 100644 index bb6cb4d948..0000000000 --- a/doc/C/preface.sgml +++ /dev/null @@ -1,174 +0,0 @@ -<!-- <!DOCTYPE preface PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> --> - <preface id="introduction"> -<!-- =============Introduction ============================= --> - <title>Introduction</title> - - <section id="what"> - <title> What is Evolution, and What Can It Do for Me?</title> - <para> - The word "evolution" means "a process of improvement and - development." The GNOME application - <application>Evolution</application> is meant to be a more - evolved <glossterm>groupware</glossterm> program, and an - integral part of the Internet-connected desktop. - </para> - <para> - As part of the GNOME project, - <application>Evolution</application> is free software. The - program and its source code are released under the terms of - the GNU Public License (GPL), and the documentation falls - under the Free Documentation License (FDL), which is included - with this document (<xref linkend="fdl">). For more - information about the GPL and the FDL, visit the Free Software - Foundation's website at <ulink - url="http://www.fsf.org">http://www.fsf.org</ulink>. - </para> - <para> - <note> - <title>This is a preview release</title> - <para> - Please help develop <application>Evolution</application> - by submitting bug reports when you find bugs. You can do - so by using the <application>Bug Report - Tool</application> (known as <command>bug-buddy</command> - at the command line). - </para> - </note> - </para> - - <para> - <application>Evolution</application> is a suite of tools to - help you work in a group. You can use it 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> - The developers of <application>Evolution</application> had - four major goals for their project: - - <itemizedlist> - <listitem> - <para> - The application must be <emphasis>both powerful and easy - to use</emphasis>. That means a familiar and intuitive - interface that users could customize to their liking, and - the development of shortcuts for complex tasks. - </para> - </listitem> - <listitem> - <para> - <application>Evolution</application> must meet and - exceed the standards set by other groupware products. - It must include support for most major network protocols - so that it can integrate seamlessly with existing - hardware and network environments. - </para> - </listitem> - <listitem> - <para> - The project must support 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> - needed to offer developers an environment for - cutting-edge application development. - </para> - </listitem> - <listitem> - <para> - Data must be safe: <application>Evolution</application> - must not lose mail or corrupt mailbox files. It will - not execute scripts, automatically forward a virus to - your entire contacts list, or delete files from your - hard disk. - </para> - </listitem> - </itemizedlist> - </para> - <para> - <application>Evolution</application> is designed to make most - daily tasks faster. 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>. 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 two 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 more advanced users, but anyone who wants to - change the way <application>Evolution</application> looks or - acts can benefit from reading it. - </para> - <formalpara> - <title>Typographical conventions</title> - <para> - Some kinds of words are marked off with special typography: - <simplelist> - <member><application>Applications</application></member> - <member><command>Commands</command> typed at the command line</member> - <member><guilabel>Labels</guilabel> for interface items</member> - - <member> Menu selections look like this: - <menuchoice> - <guimenu>Menu</guimenu> - <guisubmenu>Submenu</guisubmenu> - <guimenuitem>Menu Item</guimenuitem> - </menuchoice> - </member> - <member><guibutton>Buttons</guibutton> you can click</member> - <member><userinput>Anything you type in</userinput></member> - <member><computeroutput>Text output from a computer</computeroutput></member> - - </simplelist> - </para> - </formalpara> - </section> - </preface> - - - - - - - - - - - - diff --git a/doc/C/usage-calendar.sgml b/doc/C/usage-calendar.sgml deleted file mode 100644 index 9ec3b0f60e..0000000000 --- a/doc/C/usage-calendar.sgml +++ /dev/null @@ -1,356 +0,0 @@ -<!-- -<!DOCTYPE Chapter PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> ---> - -<chapter id="usage-calendar"> - <title>The Evolution Calendar</title> - <para> - To begin using the calendar, select - <guibutton>Calendar</guibutton> from the <interface>shortcut - bar</interface>. By default, the calendar starts showing today's - schedule on a grey and white ruled background. At the upper - right, there's a monthly calendar you can use to switch days. - Below that, there's a <guilabel>TaskPad</guilabel>, where you can - keep a sort of glorified to-do list that's not linked to your - calendar. The calendar's daily 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="fig/calendar" 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; press the calendar-shaped buttons on the - right side of the toolbar to switch between views. - </para> - <para> - To view yesterday's appointments, (last week's, if you're in - the weekly view, and last month's for the monthly view), click - the <guibutton>Pref</guibutton> button. For tomorrow, next week, - or next month, click <guibutton>Next</guibutton>, and of course, - click <guibutton>Today</guibutton> for today. - </para> - <para> - To visit a specific date's calendar entries, click - <guibutton>Go To</guibutton> and select the date in the dialog - box that appears. - </para> - - -<!-- ############### FIXME FIXME FIXME ############ -Feature not yet implemented, and may not be implemented due to -lack of time, resources, and interest. - <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> -################ END FIXME AREA ################## --> - - </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. Of course, you can also set event reminders and alarms - 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> - To create a new calendar event, select - <menuchoice> - <guimenu>File</guimenu> - <guisubmenu>New</guisubmenu> - <guimenuitem>Appointment</guimenuitem> - </menuchoice> - or click the <guibutton>New</guibutton> button on the left end - of the toolbar. The <interface>New Appointment</interface> - dialog will pop up with the usual menu bar, tool bar, and - window full of choices for you. - </para> - <para> - Your event must have a starting and ending date — by - default, today — but you can choose whether to give it - starting and ending times or to mark it as an <guilabel>All - day event</guilabel>. For the purposes of the calendar, an - <guilabel>All day event</guilabel> begins at ten in the - morning, runs until eleven at night, and is displayed at the - top of a day's event list rather than inside it. That makes - it easy to have events that overlap and fit inside each other. - For example, a conference might be an all day event, and the - meetings at the conference would be timed events. Events with - starting and ending times can also overlap, however, and when - they do they're displayed as multiple columns in the day view - of the calendar. - </para> - <note> - <title>Doing Two Things At Once</title> - <para> - If you create two calendar events that overlap, - <application>Evolution</application> will display them as - multiple columns in the calendar window. If you manage to - do both things at once, I'd like to meet you. - </para> - </note> - <para> - You can have as many as four different - <guilabel>Alarms</guilabel>, any time prior to the event - you've scheduled. You can have one alarm of each type: - <variablelist> - <varlistentry> - <term><guilabel>Display</guilabel></term> - <listitem> - <para> - A window will pop up on your screen to remind you of - your event. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Audio</guilabel></term> - <listitem> - <para> - Choose this to have your deliver a sound alarm. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Program</guilabel></term> - <listitem> - <para> - Select this if you would like some additional application - to run as a reminder. You can enter its name in the - text field, or find it with the - <guibutton>Browse</guibutton> button. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Mail</guilabel></term> - <listitem> - <para> - <application>Evolution</application> will send an - email reminder to the address you enter into the text - field. - </para> - </listitem> - </varlistentry> - </variablelist> - - </para> - <para> - <guilabel>Classification</guilabel> is a little more - complicated, and only applies to calendars on a - network. <guilabel>Public</guilabel> is the default category, - and a public event can be viewed by anyone on the calendar - sharing network. <guilabel>Private</guilabel> denotes one - level of security, and <guilabel>Confidential</guilabel> a - higer level. <!-- FIXME --> Exact determinations and implementations of - this feature have yet to be determined. <!-- FIXME --> - </para> - <para> - The <guilabel>Recurrence</guilabel> tab lets you describe - repetition in events ranging from once every day up to once - every 100 years. You can then choose a time when repetition - will stop, and, under <guilabel>Exceptions</guilabel>, pick - individual days when the event will <emphasis>not</emphasis> - recur. - </para> - - <para> - Once you're done with all those settings, click on the disk - icon in the toolbar. That will save the event and close the - event editor window. If you want, you can alter an event - summary in the calendar view by clicking on it and typing. You - can change other settings by right-clicking on the event in - the and then choosing <guimenuitem>Edit this Appointment</guimenuitem>. - </para> - </sect2> - -<!-- ############UNIMPLEMENTED FEATURES ################### - - <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. - </para> - <note> - <title>Unimplemented Feature</title> - <para>This feature is not yet implemented.</para> - </note> - - <para> - In addition, you can use <application>Evolution</application> - to mark a meeting request on another person's calendar. To do - it, click <guibutton>New</guibutton> in the calendar toolbar, - or select <menuchoice> <guimenu>File</guimenu> - <guisubmenu>New</guisubmenu> - <guimenuitem>Appointment</guimenuitem> </menuchoice> 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 deselect the - event. - </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> - ########## END UNIMPLEMENTED FEATURESET ############ --> - - </sect1> - - <sect1 id="usage-calendar-todo"> - <title>The Task Pad</title> - <para> - The Task Pad, located in the lower right corner of the - calendar, lets you keep a list of tasks separate from your - calendar events. Tasks are colored and sorted by priority and - due-date (see <xref linkend="config-prefs"> for more - information), and are included with calendar data during - synchronization with a hand-held device. - </para> - <para> - To record a new task, click the <guibutton>Add</guibutton> - button below the list. <application>Evolution</application> - will pop up a small window with five items in it: - - <variablelist> - <varlistentry> - <term> <guilabel>Summary:</guilabel></term> - <listitem> - <para> - The description you enter here will appear in the To Do - list itself. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> <guilabel>Due Date:</guilabel></term> - <listitem> - <para> - Decide when this item is - due. You can either type in a date and time, or select one from - the <guibutton>Calendar</guibutton> and time drop-down menus. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Priority:</guilabel></term> - <listitem> - <para> - Select a level of importance from 1 (most important) to 9 - (least important). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> <guilabel>Item Comments:</guilabel></term> - <listitem> - <para> - If you wish, you can keep a more detailed description of - the item here. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Once you've added a task to your to-do list, its summary - appears in the <guilabel>Summary</guilabel> section of the - calendar window. To view or edit a detailed description of an - item, double-click on it, or select it and click - <guibutton>Edit</guibutton>. You can delete items by selecting - them and clicking on the <guibutton>Delete</guibutton> button. - </para> - </sect1> - - <sect1 id="usage-calendar-multiple"> - <title>Multiple Calendars</title> - <para> - <application>Evolution</application> permits you to have and - maintain multiple calendars. This is useful if you maintain - schedules for other people, if you are responsible for resource - or room allocation, or if you have multiple personalities. - </para> - - <example> - <title>Keeping Multiple Calendars</title> - <para> - Keelyn has one calendar for her own schedule. Next to that - she maintains one for the conference room, so people know when - they can schedule meetings. On the local network, she - maintains a calendar that reflects when consultants are going - to be on site, and another that keeps track of when the Red - Sox are playing. - </para> - </example> - <para> - To create a new calendar, select - <menuchoice> - <guimenu>File</guimenu> <guisubmenu>New</guisubmenu> - <guimenuitem>Calendar</guimenuitem> - </menuchoice>. - - You can place the calendar in any calendar folder and access it - from the folder view. Alarms, configuration, and display for - each calendar are seperate from each other. - </para> - - </sect1> -</chapter> - - - - - - - - - - diff --git a/doc/C/usage-contact.sgml b/doc/C/usage-contact.sgml deleted file mode 100644 index 4f9b9fd058..0000000000 --- a/doc/C/usage-contact.sgml +++ /dev/null @@ -1,504 +0,0 @@ -<!-- -<!DOCTYPE Chapter PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> ---> - -<chapter id="usage-contact"> - <title>The Evolution Contact Manager</title> - <abstract> - <para> - The <application>Evolution</application> contact manager can - handle all of the functions of an address book, phone book, or - Rolodex. Of course, it's a lot easier to update - <application>Evolution</application> than it is to change an - actual paper book. <application>Evolution</application> also - allows easy synchronization with hand-held and remote devices. - Since <application>Evolution</application> supports most major - network protocols, including <glossterm>LDAP</glossterm>, it can - fit into almost any existing network. - </para> - <para> - Another advantage of the <application>Evolution</application> - address book is its integration with 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. Or, you can get an e-mail with contact information in - it and create a new address card on the spot. In addition, - searches and folders and all work in the same way they do in the - other components, so you don't have to learn another system for - similar tasks. - </para> - <para> - This chapter will cover using the - <application>Evolution</application> contact manager to organize - any amount of contact information, share addresses over a - network, and several ways to save time with everyday tasks. To - learn about configuring the contact manager, see <xref - linkend="config-prefs-contact">. - </para> - </abstract> - <sect1 id="usage-contact-basic"> - <title>Getting Started With the Contact Manager</title> - - <para> - To open up your address book, click on - <guibutton>Contacts</guibutton> in the shortcut bar. The - contact manager is illustrated in <xref - linkend="usage-contact-fig">. By default, the contact manager - shows all your cards in alphabetical order, in a - <glossterm>minicard</glossterm> format. You can select other - views from the <guimenu>View</guimenu> menu, and adjust the - width of the colums by clicking and dragging the grey column - dividers. - </para> - - - <figure id="usage-contact-fig"> - <title>Evolution Contact Manager</title> - <screenshot> - <screeninfo>Evolution Contact Manager Window</screeninfo> - <graphic fileref="fig/contact" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - - <para> - The toolbar for the address book is quite simple: - <itemizedlist> - <listitem><para> - Press <guibutton>New</guibutton> for a new contact. - </para></listitem> - - <listitem><para> - <guibutton>Find</guibutton> brings up an in-depth search window. - </para></listitem> - - <listitem><para> - Press <guibutton>Print</guibutton> to print one or more cards. - </para></listitem> - <listitem><para> - <guibutton>Delete</guibutton> deletes a selected card. - </para></listitem> - </itemizedlist> - </para> - <para> - The last feature is <guilabel>Quick Search</guilabel>; to use - it, just type in the name of the person you're looking for and - hit <keycap>Enter</keycap>. - <application>Evolution</application> will search through all - the cards to find one that matches. - </para> - <para> - If there are no matches, the card display will be blank. To - display <emphasis>all</emphasis> of your contacts, you can - leave the <guilabel>Quick Search</guilabel> field blank, and - press enter. - </para> - <para> - The rest of the contact manager is taken up by the display of - your cards. You can view it as a table or as a list of - cards— switch between them in the <guimenu>View</guimenu> - menu — and move through them alphabetically alphanumeric - buttons and the scrollbar at the right of the window. - </para> - </sect1> - <sect1 id="usage-contact-cards"> - <title>Destroy, Create, or Change Cards</title> - - <para> - To delete a card, click on it once to select it, then press the - <guibutton>Delete Card</guibutton> button. If you have - multiple cards selected, you'll delete mutliple cards. - </para> - <para> - Adding or changing cards is slightly more complicated. Any - time you add information to the contact manager, whether it's - an old card you're editing or a new card you're just adding to - your address book, you'll use the contact editor. To change a - card that already exists, just double click it to open the - contact editor window with all the current information already - filled in. If you want to create a new one, clicking the - <guibutton>New Card</guibutton> button will open up that same - window, but with empty fields instead of full ones. Either - way, it's the same tool for quite similar tasks, and you'll - find that it's pretty flexible and can store quite a lot more - than you'd think would fit onto a file card. - </para> - - <para> - The contact editor window has two tabs, - <guilabel>General</guilabel>, for basic contact information, - and <guilabel>Details</guilabel>, for a more specific - description of the person. In addition, it contains a full - menu bar, which is still evolving rapidly. <!-- FIXME --> - </para> - - <figure id="usage-contact-editor-fig"> - <title>Evolution Contact Editor</title> - <screenshot> - <screeninfo>Evolution Contact Editor</screeninfo> - <graphic fileref="fig/contact-new" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - - <para> The <guilabel>General</guilabel> tab contains no less - than seven sections, each with an icon: a face, for name and - company; a telephone for phone numbers; an envelope for email - address; a house for postal address; a file folder for - contacts, and a briefcase for categories. You can guess what - sort of information belongs in fields like <guilabel>Job - Title</guilabel> and <guilabel>Web page address</guilabel>, - but there are several parts of the window that are a little - more interesting. - </para> - <para> - The <guilabel>Categories</guilabel> feature is discussed in - <xref linkend="usage-contact-organize">, but the remaining - features are described here: - <variablelist> - <varlistentry> - <term>Full Name</term> - <listitem> - <para> - The <guilabel>Full Name</guilabel> field has two - major features: - <itemizedlist> - <listitem> - <para> - You can enter a name into the <guibutton>Full - Name</guibutton> field, but you can also click the - <guibutton>Full Name</guibutton> button to bring - up a small dialog box with a few text boxes - <variablelist> - <varlistentry> - <term><guilabel>Title: </guilabel></term> - <listitem> <para> - Enter an honorific or select one from the menu. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guilabel>First: </guilabel></term> - <listitem> <para> - The person's first, or given, name. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Middle: </guilabel></term> - <listitem> <para> - The middle name or initial, if any, goes here. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Last: </guilabel></term> - <listitem> <para> - The last name (surname) belongs here. - </para></listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Suffix: </guilabel></term> - <listitem> <para> - Suffixes such as "Jr." or "III" can go here. - </para></listitem> - </varlistentry> - </variablelist> - </para> - </listitem> - <listitem> - <para> - The <guilabel>Full Name</guilabel> field also - interacts with the <guilabel>File As</guilabel> - box to help you organize your contacts. - </para> - <para> - To see how it works, type a name in the - <guilabel>Full Name</guilabel> field: - <userinput>Eva Lucianne Tester</userinput>. - You'll notice that the <guilabel>File - As</guilabel> field also fills up, but in reverse: - <computeroutput>Tester, Lucianne</computeroutput>. - You can pick <computeroutput>Eva - Tester</computeroutput> from the drop-down, or - type in your own, such as <userinput>Lucianne - Tester, Eva</userinput>. - </para> - <tip> - <title>Filing Suggestion</title> - <para> - Don't enter something entirely different from - the actual name, since you might forget that - you've filed Eva's information under "F" for - "Fictitious Helix Code Employees" - </para> - </tip> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Multiple Values for Fields</term> - <listitem> - <para> - If you click on the small arrow buttons next to the - <guilabel>Primary Email</guilabel> field, you can also - choose <guilabel>Email 2</guilabel> and - <guilabel>Email 3</guilabel>. Although the contact - editor will only display one of those at any given - time, <application>Evolution</application> will - remember them all. The arrow buttons next to the - telephone and postal address fields work in the same - way. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> -<!--- ############# This section isn't implemented yet either: - <sect2> - <title></title> - <para> - <tip> - <title>Contact Shortcuts</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. 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> - </tip> - </para> - <para> - You can move cards around just as you would move email - messages: dragging and dropping works, as does right-clicking - and choosing <guimenuitem>Move</guimenuitem> from the menu - that appears. - </para> - </sect2> -############### SHORTCUT SECTION COMMENTED OUT FOR NOW --> - - </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. - Categories are discussed <xref - linkend="usage-contact-organize-group-category">. - </para> - -<!-- - <para> - Another useful UNIMPLEMENTED - <application>Evolution</application> feature is its ability to - recognize when people live or work together. If several people - in your contact manager share an address, and you change the - address for one of them, <application>Evolution</application> - will ask you if you wish to change the address for all of them, - or just for one. - </para> ---> - - <sect2 id="usage-contact-organize-group"> - <title>Groups of contacts</title> - <para> - <application>Evolution</application> offers two ways for you - to organize your cards. The first way is to use folders; - this works the same way that mail folders do. For more - flexibility, you can also mark contacts as members of - different categories. - </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. If you've read <xref - linkend="usage-mainwindow"> then you already know that you - can create a new folder by selecting - <menuchoice> - <guimenu>File</guimenu> - <guisubmenu>New</guisubmenu> - <guimenuitem>Folder</guimenuitem> - </menuchoice> - and that you can put new folders anywhere you like. Note - that each card must be in one and only one folder, unless - you want to have duplicate cards. - </para> - <para> - To put a card into a folder, just drag it there from the - folder view. Remember that contact cards can only go in - contact folders, just like mail can only go in mail folders, - and calendars in calendar folders. - </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, click the - <guibutton>Categories</guibutton> button at the lower - right. From the dialog box that appears, you can check as - many or as few categories as you like. - </para> - <para> - Then, you can refer to all the cards in that category by: - FEATURE NOT IMPLEMENTED... FIXME - </para> - <para> - If the master list of categories doesn't suit you, you can - add your own. Just enter the new category's name in the - text box, then click <guibutton>Categories</guibutton> and - choose <guilabel>Add to Master List</guilabel> in the - window that appears. - </para> - - <tip id="usage-contact-categories-multiple"> - <title>Another way to use Categories</title> - <para> - You can categorize contacts by typing the category - names into the <guilabel>Categories</guilabel> - field. You can also create new categories that way: - just type in a category name, and it counts as a - category. - </para> - </tip> - </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> - Ray wants to schedule a meeting with Company X, so he - checks the network for the Company X address card so he - knows whom to call there. Since his company also shares - calendars, he then learns that his co-worker Deanna has - already scheduled a meeting with Company X next Thursday. - He can either go to the meeting himself or ask Deanna to - discuss his concerns for him. Either way, he avoids - scheduling an extra meeting with Company X. - </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 in the office 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, wait until - <application>Evolution</application> supports this - feature. <!-- FIXME --> - </para> - </sect1> - - <sect1 id="usage-contact-automate"> - <title>Contact Manager Tools</title> - <para> - The contact manager works with - <application>Evolution</application> mail and the calendar to - help you add new address cards quickly. However, it can also - manage mailing lists. There are more tools planned, and when - they arrive, <!-- FIXME --> they will be described in this - section. - </para> - - <sect2 id="contact-automation-basic"> - <title>Send me a Card: Adding New Cards Quickly</title> - <para> - As noted before, when you get information about a person 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> also 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. - </para> - <!-- FIXME this feature not yet implemented --> - <para> - 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!</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> - <sect1 id="usage-contact-menubar"> - <title>Contact Manager Menubar Reference</title> - <para> - </para> - </sect1> -</chapter> - - - - - - - - - - - - - - diff --git a/doc/C/usage-mail.sgml b/doc/C/usage-mail.sgml deleted file mode 100644 index de2f3b0a23..0000000000 --- a/doc/C/usage-mail.sgml +++ /dev/null @@ -1,1132 +0,0 @@ -<!-- -<!DOCTYPE Chapter PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> ---> - -<chapter id="usage-mail"> - <title>Evolution Mail</title> - <abstract> - <title> An Overview of the Evolution Mailer</title> - <para> - <application>Evolution</application> email is like other email - programs in all the ways you would hope: - <itemizedlist> - <listitem> - <para> - It can sort and organize your mail in a wide variety of ways with - folders, searches, and filters. - </para> - </listitem> - <listitem> - <para> - It can send and receive mail in HTML or as plain text, and - supports file attachments. - </para> - </listitem> - <listitem> - <para> - It supports multiple mail sources, including IMAP, POP3, - and local <filename>mbox</filename> files. - </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. Both the <link - linkend="usage-mail-organize-filters">filtering</link> and <link - linkend="usage-mail-organize-search">searching</link> functions - were built for speed and efficiency on gargantuan mail - volumes. 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: - <variablelist> - - <varlistentry> - <term><guimenuitem>View Message</guimenuitem> </term> - <listitem><para> - Select this item to view the message in - the view pane of the <application>Evolution</application> - window. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Edit Message</guimenuitem></term> - <listitem><para> - This item is available only for messages and drafts - that you have written. Select it to open the message - composer and make changes to the message. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Print Message</guimenuitem> </term> - <listitem><para> - Select this item to print a message. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Reply to Sender</guimenuitem></term> - <listitem><para> - Use this item to reply only to the author of the message. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Reply to All</guimenuitem></term> - <listitem><para> - Send a reply to the author of the message - and to all others on the recipient list. See <xref - linkend="usage-mail-getnsend-send-reply"> for more information. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Forward Message</guimenuitem> </term> - <listitem><para> - Send the message on to another person. - See <xref linkend="usage-mail-getnsend-fwd"> for - information about how to use the Forward feature. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Delete Message</guimenuitem> </term> - <listitem><para> - Mark the message for deletion. Choose <menuchoice> - <guimenu>Actions</guimenu><guimenuitem>Expunge</guimenuitem> - </menuchoice> to delete marked messages permanently. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><guimenuitem>Move Message</guimenuitem> </term> - <listitem><para> - Select this item to move the message to another folder. - This will open a dialog to let you choose the destination - from a folder tree. - </para></listitem> - </varlistentry> - </variablelist> - </para> - - <para> - You can also select the order in which messages appear in - that list. To sort by sender, subject, or date, click on the - bars with those labels at the top of the message list. If - you click twice, you'll sort them in reverse order. - </para> - <para> - Aside from sorting the messages, you can opt to have the - messages threaded. Select <menuchoice> - <guimenu>View</guimenu> <guimenuitem>Threaded Message - List</guimenuitem> </menuchoice> to turn the threaded view on - or off. If the option selected, - <application>Evolution</application> will attempt to - associate related messages by using the - <systemitem>References</systemitem>, - <systemitem>In-Reply-To</systemitem>, and - <systemitem>Subject</systemitem> message headers. Messages - which are related are then placed next to each other, so that - it's easier to follow the thread of a conversation from - message to message. - </para> - <para> - Go ahead and click on the message in the <interface>message - list</interface>. That selects the message. Then click on - the <guibutton>Delete</guibutton> button in the tool bar. The - message now has a line through it, because you've marked it - for deletion. If you really want to get rid of it, choose - <guimenuitem>Expunge</guimenuitem> from the - <guimenu>Tools</guimenu> menu. That will delete it - permanently. If you want to keep it, click - <guibutton>Delete</guibutton> again, and it will no longer be - marked as deleted. At some point in the future, this feature - will change to something a little less counter-intuitive. - </para> - <!-- ==============Figure=================================== --> - - <figure id="usage-mail-intro-fig"> - <title>Evolution Mail</title> - <screenshot> - <screeninfo>Inbox</screeninfo> - <graphic fileref="fig/mail-pic" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure============================== --> - - </sect2> - - <sect2 id="usage-mail-getnsend-get"> - <title>Checking Mail</title> - <para> - To check your email, just click <guibutton>Get - mail</guibutton> in the toolbar. If this is the first time - you've done so, the <interface>mail setup - assistant</interface> will ask you for the information it - needs to check your mail (see <xref - linkend="config-setupassist"> for more information). If - you're checking mail over a network (instead of from local - <filename>mbox</filename> files), you'll need to enter your - email password. Type it in, click <guibutton>OK</guibutton> and - <application>Evolution</application> will download your mail. - New mail will appear in your <interface>Inbox</interface>. - <!-- FIXME: add mention of Today if Today feature appears --> - </para> - <para> - Once you've entered your password, - <application>Evolution</application> will hold it in memory so - that you don't have to retype it every time you want to check - mail. It will only remember the password until you quit the - application; each time you run - <application>Evolution</application>, you need to re-enter - your password. If you'd like - <application>Evolution</application> to forget your password - sooner, select - <menuchoice><guimenu>Actions</guimenu><guimenuitem>Forget - Passwords</guimenuitem></menuchoice>, and it will do so - immediately. - </para> - <para> - If you get an error message instead of mail, you probably - need to change your network settings. To learn how to - do that, have a look at <xref - linkend="config-prefs-mail-network">, or ask your system - administrator. - </para> - - <sect3 id="usage-mail-getnsend-get-attach"> - <title>Attachments, HTML Mail, and Live Documents</title> - <para> - If someone sends you a file attached to an email (an - "attachment"), <application>Evolution</application> will - display the file at the bottom of the message to which it's - attached. Text, HTML, and most images will be displayed in - the message itself. For other files, - <application>Evolution</application> will provide a link and - icon at the end of the message. Click on that, and - <application>Evolution</application> will ask you where you - want to put the file. Once you've chosen a location and - saved the file, you can open, move, copy, or execute it just - like any other, using <application>Nautilus</application> or - your favorite shell or file manager. - </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> - -<!-- ######## Feature will probably not be implemented ****** - <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> - ---> - - </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 - <menuchoice> <guimenu>File</guimenu> - <guisubmenu>New</guisubmenu> <guimenuitem> - Mail</guimenuitem></menuchoice>, or by pressing the - <guibutton>Compose</guibutton> button in the Inbox toolbar. - 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="fig/newmsg-pic" format="png" srccredit="Kevin Breit"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure=================================== --> - - <!-- Check the alignment of the following paragraph in the PS and - HTML output: it's indented for no good reason --> - <para> - Enter an address in the <guilabel>To:</guilabel> field, a - subject in the <guilabel>Subject:</guilabel> and a message in - the big empty box at the bottom of the window, and press - <guibutton>Send</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> in - the message composition window. Then, when you press - <guibutton>Send</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> - You can probably guess the purpose of the buttons labelled - <guilabel>Cut</guilabel>, <guilabel>Copy</guilabel>, - <guilabel>Paste</guilabel> and <guilabel>Undo</guilabel>, but - there's a bit more to sending mail that's less obvious. 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. - </para> - <para> - Alternately, you can click on the - <guibutton>To:</guibutton>, <guibutton>Cc:</guibutton>, or - <guibutton>Bcc:</guibutton> buttons to get a list of email - addresses. Click the check-boxes next to the addresses, then - click <guibutton>OK</guibutton>, and the address will be - added to the appropriate form field. - </para> - <para> - 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">. - </para> - - <sect4 id="usage-mail-getnsend-send-to-mult"> - <title>Multiple Recipients</title> - <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> - When 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 - received the message, and knows that he 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 you put in the - <guilabel>Bcc:</guilabel> field get the message, but - nobody else sees their email address. They will still see - the list of addresses from the <guilabel>To:</guilabel> - and <guilabel>Cc:</guilabel> fields, though. - - <example id="ex-mail-bcc"> - <title>Using the Bcc: field</title> - <para> - Tim is sending an email announcement to all of his - company's clients, some of whom are in competition - with each other, and all of whom value their - privacy. He needs to use the - <guilabel>Bcc:</guilabel> field here. If he puts - every address from his address book's "Clients" - category into the <guilabel>To:</guilabel> or - <guilabel>Cc:</guilabel> fields, he'll make the - company's <emphasis>entire</emphasis> client list - public. Don't assume it won't happen to you! - </para> - </example> - </para> - </sect4> - </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. A window like the - <interface>New Message</interface> window will appear, but - the subject will already be present— 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 is inserted into the new - message, either in italics (for HTML display) or with the - > character (in plain text mode) 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="fig/replymsg" 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 click <guibutton>Reply to All</guibutton> - instead of <guibutton>Reply</guibutton>. If there are large - numbers of people in the <guilabel>Cc:</guilabel> or - <guilabel>To:</guilabel> fields, this can save substantial - amounts of time. But be careful, and always make sure you - know who is getting a message: it could be a mailing list - with thousands of subscribers. - <example> - <title>Using the Reply to All feature</title> - <para> - Susan sends an email to a client, and sends copies to - Tim and to an internal company mailing list of - co-workers. If Tim wants to make a comment to all of - them, he uses <guibutton>Reply to All</guibutton>, but - if he just wants to tell Susan that he agrees with her, - he uses <guibutton>Reply</guibutton>. - </para> - </example> - </para> - </sect3> - - <sect3 id="usage-mail-getnsend-send-html"> - <title>Embellish your email with HTML</title> - <para> - You can't normally use text treatments or pictures in - emails, which is why you've probably seen people use - asterisks for emphasis or use - <glossterm>emoticons</glossterm> to convey their - feelings. However, most of the newer email programs can - include and display images and text treatments as well as - basic alignment and paragraph formatting. - </para> - <note> - <title>HTML Mail is not a Default Setting</title> - <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 - <application>Evolution</application> sends plain text - unless you explicitly ask for HTML. To send HTML mail, - you will need to select <menuchoice> <guimenuitem> - HTML</guimenuitem></menuchoice> in the mail settings dialog box. See - <xref linkend="config-prefs-mail-other"> for more information. - </para> - <para> - If you format a message with HTML, but do not have - <guilabel>Send Messages as HTML</guilabel> enabled in your - mail settings, the composer will remove your text styles. - It will, however, preserve indentation and lists. The - same is true for individuals in your address book whom you - have not marked as wanting to receive HTML mail. - </para> - </note> - <para> - HTML formatting tools are located just above the - composition frame, and in the <guimenu>Insert</guimenu> and - <guimenu>Format</guimenu> menus. Your message text will - appear formatted in the composer window, and the message - will be sent as HTML. - </para> - <para> - The icons in the toolbar are explained in tool-tips, which - appear when you hold your mouse over the buttons. The - buttons fall into four categories: - <variablelist> - <varlistentry> - <term>Headers and lists</term> - <listitem> - <para> - Choose <guilabel>Normal</guilabel> for a default - text style, or <guilabel>Header 1</guilabel> through - <guilabel>Header 6</guilabel> for varying sizes of - header. You can also select - <guilabel>pre</guilabel> for preformatted text - blocks, and three types of <guilabel>List - Item</guilabel>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Text style</term> - <listitem> - <para> - <itemizedlist mark="none"> - <listitem><para><guibutton>B</guibutton> is for bold text</para></listitem> - <listitem><para><guibutton>I</guibutton> for italics</para></listitem> - <listitem><para><guibutton>U</guibutton> to underline</para></listitem> - <listitem><para><guibutton>S</guibutton> for a strikethrough.</para></listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Alignment</term> - <listitem> - <para> - Located next to the text style buttons, - these three paragraph icons should be familiar to - users of most word processing software. The - leftmost button will make your text left-justified, - the center button, centered, and the right hand - button, right-justified. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>Indentation rules</term> - <listitem> - <para> - The button with the arrow pointing left will reduce - a paragraph's indentation, and the right arrow will - increase its indentation. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - There are three tools that you can find only in the - <guimenu>Insert</guimenu> menu. - <variablelist> - <varlistentry> - <term><guimenuitem>Insert Link</guimenuitem>:</term> - <listitem> - <para> - Use this tool to - put hyperlinks in your HTML messages. When you - select it, <application>Evolution</application> will - prompt you for the <guilabel>Text</guilabel> that - will appear, and the <guilabel>Link</guilabel>, where - you should enter the actual web address (URL). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> <guimenuitem>Insert Image</guimenuitem>:</term> - <listitem> - <para> - <guimenuitem>Insert Image</guimenuitem>: Select this item to - embed an image into your email, as was done in the welcome - message. Images will appear at the location of the - cursor. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guimenuitem>Insert Rule</guimenuitem>:</term> - <listitem><para> - This will insert a horizontal line, or rule, into your document. - You'll be presented with a dialog box which gives you - the choice of size, percentage of screen, shading, and - alignment; if you leave everything at the default - values you'll get a thin black rule all the way across - the screen.</para></listitem> - </varlistentry> - - </variablelist> - </para> - <note> - <title>A Technical note on HTML Tags</title> - <para> - The composer is a WYSIWYG (What You See Is What You Get) - editor for HTML. That means that if you enter HTML - directly into the composer— say, <markup - role="html"><B>Bold Text</B></markup>, the - the composer will assume you meant exactly that string - of characters, and not "make this text bold," as an HTML - composition tool or text editor would. - </para> - </note> - </sect3> - <sect3 id="usage-mail-getnsend-send-attach"> - <title>Attachments</title> - <para> - If you want to attach a file to your email message, you - can drag it from your desktop into the message window, or - click the button in the toolbar with a paper clip on it, - labelled <guibutton>Attach</guibutton>. If you click the - <guibutton>Attach</guibutton> button, - <application>Evolution</application> will open a file - selection dialog box, to ask you which file you want to - send. Select the file and click <guilabel>OK</guilabel>. - </para> - <para> - When you send the message, a copy of the file will - go with it. Be aware that big attachments can take a long - time to download. - </para> - </sect3> - -<!-- Function not implemented, -possibly never will be due to security evil. --> -<!-- - <sect3 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, this feature has not - yet been implemented. - </para> - </sect3> ---> - - <sect3 id="usage-mail-getnsend-fwd"> - <title>Forwarding Mail</title> - <para> - The post office forwards your mail for you when you change - addresses, and you can forward mail when you get a letter by - mistake. The email <guilabel>Forward</guilabel> button - works in much the same way. It's particularly useful if you - have received a message and you think someone else would - like to see it. You can forward a message as an attachment - to a new message (this is the default) 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 full, unaltered - message on to someone else. 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 you are reading, press - <guibutton>Forward</guibutton> on the toolbar, or select - <menuchoice> <guimenu>Message</guimenu> - <guimenuitem>Forward</guimenuitem> </menuchoice>. If you - prefer to forward the message <glossterm>inline</glossterm> - instead of attached, select <menuchoice> - <guimenu>Message</guimenu> <guimenuitem>Forward - Inline</guimenuitem> </menuchoice> from the menu. 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</guibutton>. - </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> - Don't send spam or forward chain mail. If you must, - watch out for hoaxes and urban legends, 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> - 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. - </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> - 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 <emphasis>need</emphasis> to sort and organize them. - Fortunately, <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> - <application>Evolution</application> keeps mail, as well as - address cards and calendars, in folders. You start out with a - few, like <guilabel>Inbox</guilabel>, - <guilabel>Outbox</guilabel>, and <guilabel>Drafts</guilabel>, - but you can create as many as you like. Create new folders by - selecting <guisubmenu>New</guisubmenu> and then - <guimenuitem>Folder</guimenuitem> from the - <guimenu>File</guimenu> menu. - <application>Evolution</application> will as you for the name - and the type of the folder, and will provide you with a folder - tree so you can pick where it goes. - </para> - <para> - When you click <guibutton>OK</guibutton>, your new folder will - appear in the <interface>folder view</interface>. You can - then put messages in it by dragging and dropping them, or by - using the <guibutton>Move</guibutton> button in the toolbar. - If you create a filter with the <interface>filter - assistant</interface>, you can have mail moved to your folder - automatically. - </para> - </sect2> - - <sect2 id="usage-mail-organize-search"> - <title>Searching for Messages</title> - <para> - Most mail clients can search through your messages for you, - but <application>Evolution</application> does it faster. You - can search through just the message subjects, just the message - body, or both body and subject. - </para> - <para> - To start searching, enter a word or phrase in the text area - right below the toolbar, and choose a search type: - <variablelist> - <varlistentry> - <term><guilabel>Body or subject contains:</guilabel></term> - <listitem> - <para> - This will search message subjects and the messages - themselves for the word or phrase you've entered in - the search field. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> <guilabel>Body contains:</guilabel> </term> - <listitem> - <para> - This will search only in message text, not the subject - lines. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Subject contains:</guilabel></term> - <listitem> - <para> - This will show you messages where the search text is - in the subject line. It will not search in the - message body. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Body does not contain:</guilabel></term> - <listitem> - <para> - 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> - </varlistentry> - <varlistentry> - <term><guilabel>Subject does not contain:</guilabel></term> - <listitem> - <para> - This finds every mail whose subject does not contain - the search text. - </para> - </listitem> - </varlistentry> - </variablelist> - - Then, press <keycap>Enter</keycap>. - <application>Evolution</application> will show your search - results in the message list. - - </para> - </sect2> - - <sect2 id="usage-mail-organize-filters"> - <title>Staying organized: Mail Filters in Evolution</title> - <para> - Filters sort your email for you as it arrives. Most often, - you'll want to have <application>Evolution</application> put - mail into different folders, but you can have it do anything - you like. People who subscribe to multiple mailing lists, or - who often need to refer to messages they have sent, find - filters especially helpful to separate personal from - list-related mail, but they're good for anybody who gets more - than a few messages a day. To create a filter, select - <menuchoice> - <guimenu>Tools</guimenu> <guimenuitem>Filter - Assistant</guimenuitem> </menuchoice>. This will bring up a - window which will guide you through filter creation. The - <interface>filter assistant</interface> is shown in <xref - linkend="usage-mail-filters-fig-new"> - - <figure id="usage-mail-filters-fig-new"> - <title>Creating a new Filter</title> - <screenshot> - <screeninfo>Creating a new Filter</screeninfo> - <graphic fileref="fig/filter-new-fig" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - - </para> - - <para> The <interface>filter assistant</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 assistant will ask you which emails it should - act upon. You can set criteria based on message size, the - sender, primary addressee or Cc: list, words in the subject or - body of the message, or any combination of criteria. Check the - boxes next to each criterion you would like to use. - </para> - <para> - Once you've decided which messages to filter, the assistant - will ask you the sort of action you wish to take. You can - file, delete, or forward the message, and you can also have it - be exempted from other filters which would otherwise have - acted upon it. - </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> - - - - <sect2 id="usage-mail-organize-vFolders"> - <title>Getting Really Organized with Virtual Folders</title> - <para> - If filters aren't flexible enough for you, or you find - yourself performing the same search again and again, consider - 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 is really a hybrid of all the other organizational - tools: it looks like a folder, it acts like a search, and you - set it up like a filter. Once you've set it up, you'll be - able to open it and read the messages in it as though it were - a normal mail folder. It's not a folder, though, because when - you open a vFolder, <application>Evolution</application> - performs a search for you. It's not a regular search, though, - because you can build a vFolder with a very complicated set of - criteria with multiple inclusions and exclusions, as though - you were setting up a filter. - </para> - -<!-- potentially useful, but doesn't fit at the moment: - <para> - An important difference between a folder and a virtual folder - 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 in which it actually exists, 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 - <emphasis>feel</emphasis> organized. But when the person - sends me mail about the topic, my whole email filing universe - becomes chaotic, and 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 more mail you need to organize, the less - you can afford the sort of confusion that stems from an - organizational system that's not flexible enough. 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. 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: vFolders in action) --> - - </para> - </example> - <para> - To create a vFolder, select <guimenuitem>VFolder - Assistant</guimenuitem> from the <guimenu>Tools</guimenu> - menu in the <interface>main window</interface>. This - will bring up a dialog box that looks suspiciously like - the Filter Assistant (for more information on filters, see - <xref linkend="usage-mail-organize-filters">), and which - presents you with a list of vFolders you have previously - created. If you have already created vFolders, you can - click on them in the frame labelled <guilabel>Select Rule - Type</guilabel>, and edit or remove them. If you have - not created any, there will be only one available option: - click <guibutton>Add</guibutton> to add a new vFolder. - </para> - <para> - You'll be prompted to create a filtering rule. You can build - your own from the ground up, or select one of several base - rules to customize. Your options are: - <variablelist> - <varlistentry> - <term><guilabel>For matching messages:</guilabel></term> - <listitem> - <para> - Choose this to create your own set of rules for the - vFolder. You may select one or more search criteria; - the vFolder you create will contain messages that - match all of them. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Messages from a certain person:</guilabel></term> - <listitem> - <para> - The remaining three rules are simpler. Select this - one to create a vFolder that will contain only - messages from an address you enter. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Messages to a certain address:</guilabel</term> - <listitem> - <para> - Any messages sent directly to this address will be in - the vFolder you create. This vFolder is an absolute - must for people with multiple email addresses. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><guilabel>Messages with a given subject:</guilabel></term> - <listitem> - <para> - Enter a subject, and the vFolder will contain messages - with that subject. - </para> - </listitem> - </varlistentry> - </variablelist> - - The selection window is shown in <xref - linkend="usage-mail-vfolder-fig-createrule"> - - <figure id="usage-mail-vfolder-fig-createrule"> - <title>Selecting a vFolder Rule</title> - <screenshot> - <screeninfo>Selecting a vFolder Rule</screeninfo> - <graphic fileref="fig/vfolder-createrule-fig" format="png" srccredit="Aaron Weber"> - </graphic> - </screenshot> - </figure> - </para> - <para> - - Once you click <guibutton>Next</guibutton>, you'll customize - the vFolder rule. The rules for the vFolder you're creating - will appear as phrases in the bottom pane of the window. You - can click on the blue underlined text in the phrase to alter - it to your liking. For example, when I create a vFolder to - contain all messages from <email>rupert@helixcode.com</email> - that have the word "evolution" in the message body, the bottom - frame says: <computeroutput>The From address matches - rupert@helixcode.com and the body contains - "evolution".</computeroutput>. - </para> - </sect2> - - </sect1> -</chapter> diff --git a/doc/C/usage-mainwindow.sgml b/doc/C/usage-mainwindow.sgml deleted file mode 100644 index 8a71f2d4f2..0000000000 --- a/doc/C/usage-mainwindow.sgml +++ /dev/null @@ -1,420 +0,0 @@ -<!-- - <!DOCTYPE Chapter PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"> ---> -<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. The first time you run the program, it will create - a directory called <filename>evolution</filename> in your home - directory, where it will keep all your - <application>Evolution</application>-related files. - </para> - <para> - After <application>Evolution</application> starts - up, you will see the <interface>main window</interface>, with the - <interface>Inbox</interface> open. It should look a lot like the - picture in <xref linkend="usage-mainwindow-fig">. On the left of - the <interface>main window</interface> is the <interface>shortcut - bar</interface>, with several buttons in it. 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 the - actual <interface>Inbox</interface>, where messages are listed - and displayed. If you're running the program for the first time, - you'll have just one message: a welcome from Helix Code. - - -<!-- ==============Figure=================================== --> - <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="Kevin Breit"> - </graphic> - </screenshot> - </figure> -<!-- ==============End of Figure=================================== --> -</para> - - <para> - <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, without the <interface>shortcut - bar</interface>, or with the <link - linkend="usage-mainwindow-folderbar">folder bar</link> - instead. - </para> - </note> - </para> - - <sect1 id="usage-mainwindow-shortcutbar"> - <title>The Shortcut Bar</title> - <para> - <application>Evolution</application>'s most important job is - to give you access to your information and help you use it - quickly. One way it does that is through the - <interface>shortcut bar</interface>, the column on the left - hand side of the main window. The large buttons with names - like <guilabel>Inbox</guilabel> and - <guilabel>Contacts</guilabel> are the shortcuts, and you can - select different groups of shortcuts by clicking the - rectangular category buttons. - </para> - <para> - The category buttons are <guibutton>Evolution - Shortcuts</guibutton> and <guibutton>Internet - Directories</guibutton>. When you click on them, they'll slide - up and down to give you access to different sorts of shortcuts. - When you first start <application>Evolution</application>, you - are looking at the <guilabel>Evolution Shortcuts</guilabel> - category. If you click <guilabel>Internet - Directories</guilabel>, it will slide up and you'll see buttons - for the <guilabel>Bigfoot</guilabel> and - <guilabel>Netcenter</guilabel> directories, as well as any - others you or your system administrator might have added. - Internet directories behave a lot like the local contact - manager, which is covered in <xref linkend="usage-contact">. - </para> - <para> - Take a look at the <guilabel>Evolution Shortcuts</guilabel> - again. They are: - - <variablelist> - -<!-- NOT IMPLEMENTED! - <varlistentry> - <term> <guibutton>Today:</guibutton></term> - <listitem> - <para> - This will bring up a summary of any new messages you've - received, along with the tasks and appointments you have - lined up for today. - </para> - </listitem> - </varlistentry> ---> - - <varlistentry> - <term> <guibutton>Inbox:</guibutton></term> - <listitem> - <para> - The Inbox 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> - </varlistentry> - - <varlistentry> - <term><guibutton>Calendar:</guibutton></term> - <listitem> - <para> - The Calendar can store your appointments and To do lists - for you. Connected to a network, you can use it to keep - a group of people on schedule and up to date. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guibutton>Contacts:</guibutton></term> - <listitem> - <para> - The Contact Manager 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> - </varlistentry> - -<!-- NOT IMPLEMENTED YET - <varlistentry> - <listitem> - <para> - The <guibutton>Tasks:</guibutton> tool combines a "to - do" list with reminders to help you keep track of - daily events. - </para> - </listitem> - </varlistentry> ---> - <varlistentry> - <term> <guibutton>Notes:</guibutton></term> - <listitem> - <para> The note pad is your catch-all tool: use it to take - messages from phone conversations, keep small things - organized, write <glossterm>haiku</glossterm>, or whatever - you like. This feature is not yet implemented, but will be - soon. See <xref linkend="usage-notes"> for more - information. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - If you prefer to use a keyboard shortcut, or <glossterm>hot - key</glossterm>, you can use those instead. They're shown next - to their equivalent menu items in the menu bar. You can also set - your own hot keys for functions that don't have any; this is - covered in <xref linkend="config">. If you're using the - keyboard shortcuts you may also want to hide the - <interface>shortcut bar</interface> by selecting - <menuchoice> <guimenu>View</guimenu> <guimenuitem>Show Shortcut - Bar</guimenuitem> </menuchoice>. - </para> - - <tip> - <title>Two Shortcut Bar Tricks</title> - <para> - To remove a shortcut from the shortcut bar, right-click on it - and select <guimenuitem>Remove</guimenuitem>. </para> - <para> - To change the way the shortcut bar looks, right-click in an - empoy space on the shortcut bar. From the menu that appears, - you can select icon sizes. - </para> - </tip> - </sect1> - - <sect1 id="usage-mainwindow-folderbar"> - <title>The Folder Bar</title> - <para> - The <interface>folder bar</interface> is a more comprehensive - way to view the information you've stored with - <application>Evolution</application>. It displays all your - appointments, address cards, and email in a tree that's a lot - like a <glossterm>file tree</glossterm>— it starts small - at the top, and branches downwards. On most computers, there - will be three folders at the base. The first one is - <guilabel>VFolders</guilabel>, for virtual folders (discussed in - <xref linkend="usage-mail-organize-vfolders">. The next one is - <guilabel>External Directories</guilabel>, for contact - directories stored on a network. The most important one is - probably <guilabel>Local</guilabel>, which you can use to access - all the data that's stored on your computer. If you click on - the plus sign plus sign next to the <guilabel>Local</guilabel> - folder, you'll see the contents: - <itemizedlist> - <listitem> - <para> - <guilabel>Calendar</guilabel>, for appointments and - event listings. - </para> - </listitem> - <listitem> - <para> - <guilabel>Contacts</guilabel>, for address cards. - </para> - </listitem> - <listitem> - <para> - <guilabel>Directories</guilabel>, for Internet contact directories. - </para> - </listitem> - <listitem> - <para> - <guilabel>Inbox</guilabel>, for incoming mail. - </para> - </listitem> - <listitem> - <para> - <guilabel>Outbox</guilabel>, which is for drafts of - messages and mail that's already been sent. - </para> - </listitem> - </itemizedlist> - - </para> - - <para> - To create a new folder, select <menuchoice> - <guimenu>File</guimenu> <guisubmenu>New</guisubmenu> - <guimenuitem>Folder</guimenuitem></menuchoice>. You'll be asked where you want to - put it, and what kind of folder it should be. You can choose - from three types: <guilabel>Mail</guilabel>, for storing mail, - <guilabel>Calendar</guilabel> for storing calendars, and - <guilabel>Contacts</guilabel> for storing contacts. - </para> - - <note> - <title>Folders Have Limits</title> - <para> - You can always place a folder inside other folders, - regardless of folder type. However, calendars, - contacts, and mail can't go into the same - folder. Calendars have to go in calendar folders, mail - in mail folders, and contacts in contact folders. - </para> - </note> - - <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><guimenuitem>View</guimenuitem>, to view a message.</para></listitem> - <listitem><para><guimenuitem>Something else</guimenuitem>, for another purpose. </para></listitem> - <listitem><para><guimenuitem>Something else</guimenuitem>, for another purpose. </para></listitem> - </itemizedlist>. - </para> - - <tip> - <title>Context-Sensitive Help</title> - <para> - GNOME 2.0 supports context-sensitive help, which means 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, choosing <guimenuitem>Help</guimenuitem> from the - right-click menu is a good way to find out. - </para> - </tip> - - <para> - Any time new information arrives in a folder, that folder label - is displayed as bold text. - </para> - <para> - To delete a folder, right-click it and select - <guimenuitem>Delete</guimenuitem> from the menu that pops up. - To change the order of folders, or put one inside another, use - <glossterm>drag-and-drop</glossterm>. To move individual - messages, appointments, and address cards between folders, you - can do the same thing: drag them where you want them, and - they'll go. - </para> - </sect1> - <sect1 id="usage-mainwindow-menubar"> - <title>The Menu Bar</title> - <para> - The <interface>menu bar</interface>'s contents will always - provide all the possible actions for any given view of your - data. That means that, depending on the context, menu bar items - will change. If you're looking at your Inbox, most of the menu - items will relate to mail; some will relate to other components - of <application>Evolution</application> and some, especially - those in the <guimenu>File Menu</guimenu> will relate to the - application as a whole. This section describes those items that - cover the application as a whole; items specific to mailer are - discussed in the mail chapter, calendar items in the calendar - chapter, and so forth. - </para> - <para> - <variablelist> - <varlistentry> - <term> <guimenu>File</guimenu> Menu</term> - - <listitem><para> - Anything related to a file falls under this - menu: - <itemizedlist> - <listitem><para> - <guisubmenu>New... — </guisubmenu> If you - want to create a new folder, calendar, - appointment, address card, or message, this is - where you should look. - </para></listitem> - - <listitem><para> - <guimenuitem>Go to Folder — </guimenuitem> - Select this item, then choose which folder you'd - like to view. - </para></listitem> - <listitem><para> - <guimenuitem>Exit — </guimenuitem> Quits the application. - </para></listitem> - - <listitem><para> - <guimenuitem>Print... — </guimenuitem> Opens the printing - dialog box so you can print items from the view pane of - <application>Evolution</application>. - </para></listitem> - </itemizedlist> - </para></listitem> - </varlistentry> - - <varlistentry> - <term> <guimenu>Edit</guimenu> Menu </term> - <listitem><para> - Although it doesn't contain anything at first, - the <guimenu>Edit</guimenu> menu fills up with - useful editing tools when you're... editing. - </para></listitem> - </varlistentry> - - <varlistentry> - <term> <guimenu>Tools</guimenu> Menu </term> - <listitem><para> All of your assistants and configuration - tools go here. For the <interface>Inbox</interface>, that - means things like <guimenuitem>Mail - Configuration</guimenuitem> and the <guimenuitem>vFolder - Editor</guimenuitem>. For the - <interface>Calendar</interface> and the <interface>Contact - Manager</interface> </para></listitem> - </varlistentry> - - <varlistentry> - <term> <guimenu>Actions</guimenu> Menu </term> - <listitem><para> - This menu contains a list of actions you can perform on - the information you've stored with - <application>Evolution</application>. The contents vary - depending on the view, but for the - <interface>Inbox</interface>, it contains items like - <guimenuitem>Mark All Messages Read</guimenuitem> and - <guimenuitem>Expunge</guimenuitem>, to erase all the - messages you've marked for deletion. - </para></listitem> - </varlistentry> - - <varlistentry> - <term> <guimenu>Help</guimenu> Menu</term> - <listitem><para> - Select among these items to open the - <application>Help Browser</application> to the appropriate section. - </para></listitem> - </varlistentry> - </variablelist> - </para> - <para> - Once you've familiarized yourself with the <interface>main - window</interface> you can start doing things with it. We'lql - start with your email inbox: you've got a letter waiting for you - already. - </para> - </sect1> -</chapter> - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/C/usage-notes.sgml b/doc/C/usage-notes.sgml deleted file mode 100644 index a4161da810..0000000000 --- a/doc/C/usage-notes.sgml +++ /dev/null @@ -1,41 +0,0 @@ -<chapter id="usage-notes"> - <title>Evolution Notes</title> - <abstract> - <title> An Overview of the Evolution Notes</title> - <para> - In the dark ages before email was invented, there were notes. - Even now, notes are an almost necessary part of our lives. It - only makes sense that <application> Evolution</application> has - a Notes feature. <application>Evolution</application> can help - you take notes in the following ways: - <itemizedlist> - <listitem> - <para> - You can take down phone numbers, take school notes, take phone - messages, or even write poetry. - </para> - </listitem> - <listitem> - <para> - You can color code each note to help cateogrize each note into - a topic. - </para> - </listitem> - <listitem> - <para> - Something - </para> - </listitem> - <listitem> - <para> - Something - </para> - </listitem> - </itemizedlist> - </para> - <para> - You can start writing notes by clicking <guibutton>Notes</guibutton> in the - shortcut bar. - </para> - </abstract> -</chapter> diff --git a/doc/C/usage-sync.sgml b/doc/C/usage-sync.sgml deleted file mode 100644 index 07325e1848..0000000000 --- a/doc/C/usage-sync.sgml +++ /dev/null @@ -1,22 +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>, put - your hand-held device on the cradle and press the HotSync - button. - </para> - <para> - 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 9aedca8af0..0000000000 --- a/doc/ChangeLog +++ /dev/null @@ -1,329 +0,0 @@ -2000-08-09 Aaron Weber <aaron@helixcode.com> - - * C/usage-mainwindow.sgml: Redid menubar description. - - - * C/config-prefs.sgml: Added coverage of folder config, requested - that feature be transferred to config section. Switched to - variablelist in "Other" config section. - - * C/usage-mail.sgml: Added coverage of right-click on messages, - threaded-view. - - * C/usage-mainwindow.sgml: Right-click on folder menu reinstated. - -2000-08-07 Aaron Weber <aaron@helixcode.com> - - * C/config-prefs.sgml: Added news server coverage. Other config - proofing changes. - - -2000-08-05 Aaron Weber <aaron@helixcode.com> - - * C/apx-gpl.sgml: New file. Contains contents of "COPYING", - but marked up (probably not very well, but valid) as docbook - (SGML). - - * C/evolution-guide.sgml: Subtle change to the legal notice: - distinguished manual license from software license. Linked to - apx-gpl.sgml above. - - * C/usage-calendar.sgml: I redid all the usage files. - -2000-07-21 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: Added password remembering/forgetting feature. - - * C/config-prefs.sgml: Mostly moved to variablelists, a few - language changes. - - * C/config-setupassist.sgml: Minor changes to formatting, wording. - - * C/usage-notes.sgml: Changed trademark references, other minor - changes. - - * C/usage-calendar.sgml: Minor fixes, added additional calendar - section, removed references to unimplemented features. Spellcheck, - prep for 0.3 release. - -2000-07-19 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: lots of minor fixes to language. added - desc. of clahey's cool button-address thing. - - * C/usage-mainwindow.sgml: fixed itemizedlists, ch. to shortcut - bar & folder descs, removed refs to trash. - -2000-07-18 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Altered category addition stuff, plus - suggestions from Kevin. - - * C/apx-gloss.sgml: Added ldap and signature definitions (from - Kevin). - - * C/usage-mail.sgml: Move to variablelists from itemizedlists. - -2000-07-14 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: moved to variablelists from itemizedlists - * C/usage-calendar.sgml: moved to variablelists from itemizedlists - -2000-06-29 Aaron Weber <aaron@helixcode.com> - - * C/preface.sgml: Minor fixes. - - * C/usage-notes.sgml: New File for feature that is yet to come. - * C/evolution-guide.sgml: Added entity for notes chapter. - * C/usage-mainwindow.sgml: Un-commented references to notes section. - - * C/apx-authors.sgml: Removed dcm from author list. - - * C/usage-calendar.sgml: Added to-do list features. - -2000-06-28 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: commented out future features; redid - contact editor stuff. - - * C/apx-gloss.sgml: Removed "live doc" and added "minicard" - -2000-06-27 Aaron Weber <aaron@helixcode.com> - - * C/devel-action.sgml: Removed file. - * C/devel-script.sgml: Same. - * C/devel-component.sgml: Same. - * C/preface.sgml: Removed references to devel section. - * C/evolution-guide.sgml: Removed references to devel section. - -2000-06-23 Aaron Weber <aaron@helixcode.com> - - * C/evolution-guide.sgml: Made moderate to major stylistic updates - to this, apx-gloss.sgml, and to all files beginning with "usage," - especially wrt HTML mail. - - -<<<<<<< ChangeLog -2000-06-15 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Category stuff improved. - - * C/usage-calendar.sgml: Now covers how to add an event properly. - -======= -======= -======= -2000-07-17 Federico Mena Quintero <federico@helixcode.com> - - * Makefile.am (SUBDIRS): Added the devel directory. - ->>>>>>> 1.15 -2000-06-28 Peter Williams <peterw@curious-george.helixcode.com> - - * C/Makefile.am (SGML_FILES): Don't depend on the newly-removed - devel-*.sgml files. - ->>>>>>> 1.13 -2000-06-16 Damon Chaplin <damon@helixcode.com> - - * C/.cvsignore: added evolution-guide and evolution-guide.junk - so we don't get the '? doc/C/evolution-guide' messages each time we - do a cvs update. - ->>>>>>> 1.12 -2000-06-14 Aaron Weber <aaron@helixcode.com> - - * C/usage-mainwindow.sgml: added sect on menubar, other minor changes. - - * C/usage-mail.sgml: Improved filter and vfolder - description, and some minor changes from me and Kevin. - -2000-06-07 Aaron Weber <aaron@helixcode.com> - - * C/config-prefs.sgml: finished adding calendar prefs. screenshots. - * C/fig/config-cal.png: new file (screenshot for above) - * C/fig/config-mail.png: same - -2000-06-05 Aaron Weber <aaron@helixcode.com> - - * C/usage-calendar.sgml: Incorporated chgs from Kevin. - - * C/config-prefs.sgml: began total overhaul of structure and added - content reflecting new prefs items. needs LOTS more work. - - * C/usage-mail.sgml: changed some references to id's in the - config-prefs section. - - * C/fig/config-mail.png: changed filename from config-prefs.png - -2000-06-01 Aaron Weber <aaron@helixcode.com> - - * C/config-prefs.sgml: filename was wrong, altered. - - * C/usage-mail.sgml: improved filter instructions, vFolder - instructions. still need work though. - - - * C/usage-contact.sgml: added screenshot. - - * C/usage-calendar.sgml: added screenshot. - - * C/config-prefs.sgml: added screenshots, and now describes the - actual prefs dialogs. - - * C/fig/config-camel.png: new (screenshot) file - * C/fig/filter-druid.png: same - * C/fig/vfolder-druid.png: same - * C/fig/calendar.png: same - * C/fig/contact.png: same - * C/fig/vfolder-createrule-fig.png: same - * C/fig/filter-new-fig.png: same - * C/fig/config-camel.png: same - -2000-06-01 Dan Winship <danw@helixcode.com> - - * Makefile.am: recurse into the C directory - - * C/Makefile.am: Rules to build and install the docs. Mostly - stolen from gnomecal. Only works if you have GDP stuff - (http://www.gnome.org/gdp/) set up on your machine, but won't make - the build fail if you don't. - -2000-05-29 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: incorporated kevins notes. - * C/usage-mainwindow.sgml: incorporated kevins notes. - -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/Makefile.am b/doc/Makefile.am deleted file mode 100644 index 7b5420fee8..0000000000 --- a/doc/Makefile.am +++ /dev/null @@ -1 +0,0 @@ -SUBDIRS = C devel diff --git a/doc/devel/.cvsignore b/doc/devel/.cvsignore deleted file mode 100644 index c24a54fbcc..0000000000 --- a/doc/devel/.cvsignore +++ /dev/null @@ -1,4 +0,0 @@ -Makefile -Makefile.in -html -evolution-devel-guide.html diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog deleted file mode 100644 index 7e0c8147ba..0000000000 --- a/doc/devel/ChangeLog +++ /dev/null @@ -1,35 +0,0 @@ -2000-08-14 Federico Mena Quintero <federico@helixcode.com> - - * calendar/cal-util/*: Integrated the cal-util library into the - documentation framework. - - * calendar/Makefile.am (SUBDIRS): Added the cal-util directory. - - * evolution-devel-guide.sgml: Added entities for the cal-util stuff. - Added entity for libical. - - * calendar/reference.sgml: Added the cal-util reference entries. - - * calendar/cal-client/evolution-cal-client-sections.txt: Updated - for new API. - -2000-08-09 Peter Williams <peterw@helixcode.com> - - * Makefile.am (maintainer-clean-local): Don't depend - on 'clean'; this messes up maintainer-clean. - -2000-07-17 Federico Mena Quintero <federico@helixcode.com> - - * calendar/cal-client/tmpl/cal-client.sgml: Populated. - - * evolution-devel-guide.sgml: New <book> toplevel for the - Evolution Developer's Guide. - - * calendar/evolution-calendar.sgml: New <part> for the calendar - developer's documentation. - - * calendar/architecture.sgml: New <chapter> for the calendar - architecture. - - * calendar/reference.sgml: New <reference> for the calendar API - reference. diff --git a/doc/devel/Makefile.am b/doc/devel/Makefile.am deleted file mode 100644 index 0d3cec5a1c..0000000000 --- a/doc/devel/Makefile.am +++ /dev/null @@ -1,64 +0,0 @@ -SUBDIRS = calendar - -# The name of the module. -DOC_MODULE=evolution-devel-guide - -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-devel-guide.sgml - -HTML_DIR=$(datadir)/gnome/html - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -evolution_devel_guidedir = $(HTML_DIR) -evolution_devel_guide_DATA = \ - evolution-devel-guide.html - -content_files = \ - evolution-devel-guide.sgml - -EXTRA_DIST = \ - $(evolution_devel_guide_DATA) \ - $(content_files) - -if ENABLE_GTK_DOC -evolution-devel-guide.html: html/book1.html - -cd $(srcdir) && cp html/book1.html evolution-devel-guide.html -else -evolution-devel-guide.html: -endif - -html/book1.html: $(content-files) - $(MAKE) html - -html: - test -d $(srcdir)/html || mkdir $(srcdir)/html - -cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - -clean-local: - rm -f *~ *.bak *.signals *-unused.txt - -maintainer-clean-local: - cd $(srcdir) && rm -rf html - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - echo '-- Fixing Crossreferences' ; \ - gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \ - fi) - -dist-hook: - mkdir $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - -.PHONY: html diff --git a/doc/devel/calendar/.cvsignore b/doc/devel/calendar/.cvsignore deleted file mode 100644 index 282522db03..0000000000 --- a/doc/devel/calendar/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/devel/calendar/Makefile.am b/doc/devel/calendar/Makefile.am deleted file mode 100644 index 2220e1d59b..0000000000 --- a/doc/devel/calendar/Makefile.am +++ /dev/null @@ -1,6 +0,0 @@ -SUBDIRS = cal-client cal-util - -EXTRA_DIST = \ - architecture.sgml \ - evolution-calendar.sgml \ - reference.sgml diff --git a/doc/devel/calendar/architecture.sgml b/doc/devel/calendar/architecture.sgml deleted file mode 100644 index 08e4c82b35..0000000000 --- a/doc/devel/calendar/architecture.sgml +++ /dev/null @@ -1,94 +0,0 @@ - <chapter id="calendar-architecture"> - <title>Architecture of the Calendar</title> - - <para> - This chapter gives an overview of the Evolution Calendar - architecture. It describes the model/view split of the calendar - into a personal calendar server, or PCS, and the GUI clients - that appear inside the Evolution shell. - </para> - - <!-- Model/View Separation --> - - <sect1 id="calendar-model-view"> - <title>Model/View Separation</title> - - <para> - Like other base components in Evolution, the calendar - separates the data model from the views or clients. This is - done so that multiple clients can access the same calendar - data in an orderly fashion and without clashes. For example, - the user may be running a graphical calendar client. If he - then wants to synchronize his calendar with a handheld device, - then the corresponding synchronization program (e.g. a conduit - for the <application>gnome-pilot</application> package) will - also need to access the calendar storage. It is important - that both the GUI client and the synchronization program keep - a consistent view of the calendar at all times, otherwise one - of them will be left in an inconsistent state if the - calendar's data changes unexpectedly. - </para> - - <para> - Evolution puts the calendar storage in a daemon called the - Wombat and completely separates it from clients who wants to - access calendar data. This part of the Wombat is called the - personal calendar server, or &PCS;. Clients must contact the - &PCS; and ask it to open an existing calendar or create a new - one. When a calendar component object (e.g. an appointment or - to-do item) changes in the &PCS; it will notify all the - clients that are using the component's parent calendar. - </para> - </sect1> - - <!-- Personal Calendar Server --> - - <sect1> - <title>Personal Calendar Server</title> - - <para> - The personal calendar server, or &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> - - </para> - </formalpara> - </sect1> - </chapter> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/calendar/cal-client/.cvsignore b/doc/devel/calendar/cal-client/.cvsignore deleted file mode 100644 index 0842a93f7a..0000000000 --- a/doc/devel/calendar/cal-client/.cvsignore +++ /dev/null @@ -1,3 +0,0 @@ -sgml -Makefile -Makefile.in diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index 44d43639a8..0000000000 --- a/doc/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,76 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module. -DOC_MODULE=evolution-cal-client - -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-cal-client.sgml - -# The directory containing the source code (if it contains documentation). -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client - -CFLAGS =" \ - -I$(top_srcdir)/calendar \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - -I$(top_builddir)/libical/src/libical \ - -I$(top_srcdir)/libical/src/libical \ - $(BONOBO_VFS_GNOME_CFLAGS) \ - " - -LDFLAGS=" \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-client/.libs/libcal-client.a \ - $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/libical.a \ - $(top_builddir)/libversit/.libs/libversit.al \ - " - -HTML_DIR=$(datadir)/gnome/html - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -tmpl_sources = \ - tmpl/cal-client.sgml \ - tmpl/evolution-cal-client-unused.sgml - -evolution_cal_client_docdir = $(HTML_DIR) -evolution_cal_client_doc_DATA = \ - evolution-cal-client.hierarchy \ - evolution-cal-client.types \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt - -EXTRA_DIST = \ - $(evolution_cal_client_doc_DATA) - -sgml/evolution-cal-client-doc.bottom: $(tmpl_sources) - $(MAKE) sgml - -scan: - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="cal-listener.h evolution-calendar.h" ) - -templates: scan - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - -sgml: - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) - -clean-local: - rm -f *~ *.bak *.signals *-unused.txt - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -dist-hook: - mkdir $(distdir)/sgml - mkdir $(distdir)/tmpl - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml - -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml - -.PHONY : sgml templates scan diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt deleted file mode 100644 index 0574d70678..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,132 +0,0 @@ -<MACRO> -<NAME>CAL_CLIENT_TYPE</NAME> -#define CAL_CLIENT_TYPE (cal_client_get_type ()) -</MACRO> -<MACRO> -<NAME>CAL_CLIENT</NAME> -#define CAL_CLIENT(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_TYPE, CalClient)) -</MACRO> -<MACRO> -<NAME>CAL_CLIENT_CLASS</NAME> -#define CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_TYPE, CalClientClass)) -</MACRO> -<MACRO> -<NAME>IS_CAL_CLIENT</NAME> -#define IS_CAL_CLIENT(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_CAL_CLIENT_CLASS</NAME> -#define IS_CAL_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>CalClient</NAME> -</STRUCT> -<STRUCT> -<NAME>CalClientClass</NAME> -</STRUCT> -<ENUM> -<NAME>CalClientLoadStatus</NAME> -typedef enum { - CAL_CLIENT_LOAD_SUCCESS, - CAL_CLIENT_LOAD_ERROR, - CAL_CLIENT_LOAD_IN_USE, - CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED -} CalClientLoadStatus; -</ENUM> -<ENUM> -<NAME>CalClientGetStatus</NAME> -typedef enum { - CAL_CLIENT_GET_SUCCESS, - CAL_CLIENT_GET_NOT_FOUND, - CAL_CLIENT_GET_SYNTAX_ERROR -} CalClientGetStatus; -</ENUM> -<STRUCT> -<NAME>CalClient</NAME> -struct CalClient { - GtkObject object; - - /* Private data */ - gpointer priv; -}; -</STRUCT> -<FUNCTION> -<NAME>cal_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_client_construct</NAME> -<RETURNS>CalClient *</RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_new</NAME> -<RETURNS>CalClient *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_client_load_calendar</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *str_uri -</FUNCTION> -<FUNCTION> -<NAME>cal_client_create_calendar</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *str_uri -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_n_objects</NAME> -<RETURNS>int </RETURNS> -CalClient *client, CalObjType type -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_object</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClient *client,const char *uid,CalComponent **comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uid_by_pilot_id</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClient *client,unsigned long pilot_id,char **uid -</FUNCTION> -<FUNCTION> -<NAME>cal_client_update_pilot_id</NAME> -<RETURNS>void </RETURNS> -CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uids</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_objects_in_range</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type,time_t start, time_t end -</FUNCTION> -<FUNCTION> -<NAME>cal_client_generate_instances</NAME> -<RETURNS>void </RETURNS> -CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn cb, gpointer cb_data -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_alarms_in_range</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, time_t start, time_t end -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_alarms_for_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *uid,time_t start, time_t end,GList **alarms -</FUNCTION> -<FUNCTION> -<NAME>cal_client_update_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_remove_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *uid -</FUNCTION> diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt deleted file mode 100644 index c37b223247..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ /dev/null @@ -1,37 +0,0 @@ -<INCLUDE>cal-client/cal-client.h</INCLUDE> - -<SECTION> -<FILE>cal-client</FILE> -CAL_CLIENT -<TITLE>CalClient</TITLE> - -CalClientLoadStatus -CalClientGetStatus -cal_client_new -cal_client_load_calendar -cal_client_create_calendar -cal_client_get_n_objects -cal_client_get_object -cal_client_get_objects_in_range -cal_client_generate_instances -cal_client_get_uid_by_pilot_id -cal_client_update_pilot_id -cal_client_get_uids -cal_client_get_alarms_in_range -cal_client_get_alarms_for_object -cal_client_update_object -cal_client_remove_object - -<SUBSECTION Standard> - -CAL_CLIENT_TYPE -IS_CAL_CLIENT -CAL_CLIENT_CLASS -IS_CAL_CLIENT_CLASS -cal_client_get_type -cal_client_construct - -<SUBSECTION Private> -CalClient - -</SECTION> diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.args b/doc/devel/calendar/cal-client/evolution-cal-client.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.args +++ /dev/null diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy b/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy deleted file mode 100644 index 88efa3e673..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalClient diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.signals b/doc/devel/calendar/cal-client/evolution-cal-client.signals deleted file mode 100644 index 97e360b6a2..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.signals +++ /dev/null @@ -1,21 +0,0 @@ -<SIGNAL> -<NAME>CalClient::cal-loaded</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -GtkEnum arg1 -</SIGNAL> - -<SIGNAL> -<NAME>CalClient::obj-updated</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -GtkString arg1 -</SIGNAL> - -<SIGNAL> -<NAME>CalClient::obj-removed</NAME> -<RETURNS>void</RETURNS> -CalClient *calclient -GtkString arg1 -</SIGNAL> - diff --git a/doc/devel/calendar/cal-client/evolution-cal-client.types b/doc/devel/calendar/cal-client/evolution-cal-client.types deleted file mode 100644 index 84d65a6637..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client.types +++ /dev/null @@ -1,4 +0,0 @@ -#include <gnome.h> -#include <cal-client/cal-client.h> - -cal_client_get_type diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml deleted file mode 100644 index a146709b8a..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,291 +0,0 @@ -<!-- ##### SECTION Title ##### --> -CalClient - -<!-- ##### SECTION Short_Description ##### --> -GTK+ object for communication with personal calendar server. - -<!-- ##### SECTION Long_Description ##### --> - <para> - The #CalClient object provides a nice GTK+ wrapper for the CORBA - interfaces that are used to communicate between calendar clients - and the personal calendar server in the user's Wombat daemon. - </para> - - <para> - After a #CalClient object is created with cal_client_new(), it - should be asked to send a request to the personal calendar server - to load or create a calendar based on its URI. The server will - asynchronously notify the client about completion of the request, - and will return an appropriate result code; this should be noted - by the client with the <link - linkend="CalClient--cal-loaded">cal_loaded</link> signal. - </para> - - <para> - When a client asks the server to update or delete a calendar - component from the storage, the server will do so and then notify - all the clients about the update or removal. This is the core of - the model/view split between calendar clients and the storage in - the personal calendar server. Clients should watch the <link - linkend="calclient-obj-updated">obj_updated</link> and <link - linkend="calclient-obj-removed">obj_removed</link> signals on the - CalClient objects they create so that they can be notified about - changes in the storage. - </para> - -<!-- ##### SECTION See_Also ##### --> - <para> - - </para> - -<!-- ##### MACRO CAL_CLIENT ##### --> - <para> - Casts a #GtkObject to a #CalClient. - </para> - -@obj: A GTK+ object. - - -<!-- ##### ENUM CalClientLoadStatus ##### --> - <para> - These values describe the status of a calendar load or create - request. After asking a calendar factory to load or create a - calendar, the provided listener will get notification about the - result in asynchronous fashion. Such notification is represented - by one of these enumeration values. For values other than - #CAL_CLIENT_LOAD_SUCCESS, the #CalClient object will not accept - any other operations on the calendar and it should just be - destroyed. - </para> - -@CAL_CLIENT_LOAD_SUCCESS: Indicates a successful load or create - operation; the corresponding calendar is ready for use. -@CAL_CLIENT_LOAD_ERROR: Indicates an error while loading or creating - the calendar. -@CAL_CLIENT_LOAD_IN_USE: Indicates that a create request failed - because the specified calendar was already being used by another - client. -@CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED: Indicates an error due to - trying to load a calendar for which a backend type is not present. - -<!-- ##### ENUM CalClientGetStatus ##### --> - <para> - These values describe the result of the cal_client_get_object() - function. - </para> - -@CAL_CLIENT_GET_SUCCESS: Indicates a successful get operation. -@CAL_CLIENT_GET_NOT_FOUND: Indicates that the requested object was - not found. -@CAL_CLIENT_GET_SYNTAX_ERROR: Indicates a syntax error when parsing - the requested object. This could indicate a bug in the calendar - client libraries or in the Wombat server. - -<!-- ##### FUNCTION cal_client_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_client_load_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - - -<!-- ##### FUNCTION cal_client_create_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_n_objects ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_object ##### --> -<para> - -</para> - -@client: -@uid: -@comp: -@Returns: -<!-- # Unused Parameters # --> -@ico: - - -<!-- ##### FUNCTION cal_client_get_objects_in_range ##### --> -<para> - -</para> - -@client: -@type: -@start: -@end: -@Returns: - - -<!-- ##### FUNCTION cal_client_generate_instances ##### --> -<para> - -</para> - -@client: -@type: -@start: -@end: -@cb: -@cb_data: - - -<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### --> -<para> - -</para> - -@client: -@pilot_id: -@uid: -@Returns: - - -<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> -<para> - -</para> - -@client: -@uid: -@pilot_id: -@pilot_status: - - -<!-- ##### FUNCTION cal_client_get_uids ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_alarms_for_object ##### --> -<para> - -</para> - -@client: -@uid: -@start: -@end: -@alarms: -@Returns: - - -<!-- ##### FUNCTION cal_client_update_object ##### --> -<para> - -</para> - -@client: -@comp: -@Returns: -<!-- # Unused Parameters # --> -@ico: - - -<!-- ##### FUNCTION cal_client_remove_object ##### --> -<para> - -</para> - -@client: -@uid: -@Returns: - - -<!-- ##### SIGNAL CalClient::cal-loaded ##### --> - <para> - This signal is emitted some time after the calendar clients sends - a load or create request to the personal calendar server. The - server will notify the client asynchronously of the completion of - the request. The @status parameter indicates the status of the - request. - </para> - -@calclient: the object which received the signal. -@arg1: -<!-- # Unused Parameters # --> -@client: Calendar client which received the notification. -@status: Status of the request. See the description of - #CalClientLoadStatus for more details. - -<!-- ##### SIGNAL CalClient::obj-updated ##### --> - <para> - This signal is emitted when the calendar clients receives - notification of a calendar component's data being changed in the - personal calendar server. Graphical clients may want to get the - new version of the object and update their display, for example. - </para> - -@calclient: the object which received the signal. -@arg1: -<!-- # Unused Parameters # --> -@client: Calendar client which received the notification. -@uid: Unique identifier of the calendar component that changed in the - personal calendar server's storage. - -<!-- ##### SIGNAL CalClient::obj-removed ##### --> - <para> - This signal is emitted when the calendar client receives - notification for a calendar component being removed from the - storage in the personal calendar server. Graphical clients may - want to delete the corresponding object from their display, for - example. - </para> - -@calclient: the object which received the signal. -@arg1: -<!-- # Unused Parameters # --> -@client: Calendar client which received the notification. -@uid: Unique identifier of the calendar component that was removed - from the personal calendar server's storage. - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") -End: ---> - diff --git a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml deleted file mode 100644 index 5576dbd57f..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,10 +0,0 @@ -<!-- ##### FUNCTION cal_client_get_events_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - diff --git a/doc/devel/calendar/cal-util/.cvsignore b/doc/devel/calendar/cal-util/.cvsignore deleted file mode 100644 index 0842a93f7a..0000000000 --- a/doc/devel/calendar/cal-util/.cvsignore +++ /dev/null @@ -1,3 +0,0 @@ -sgml -Makefile -Makefile.in diff --git a/doc/devel/calendar/cal-util/Makefile.am b/doc/devel/calendar/cal-util/Makefile.am deleted file mode 100644 index 8861aa03cb..0000000000 --- a/doc/devel/calendar/cal-util/Makefile.am +++ /dev/null @@ -1,75 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module. -DOC_MODULE=evolution-cal-util - -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-cal-util.sgml - -# The directory containing the source code (if it contains documentation). -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util - -CFLAGS =" \ - -I$(top_srcdir)/calendar \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - -I$(top_builddir)/libical/src/libical \ - -I$(top_srcdir)/libical/src/libical \ - $(BONOBO_VFS_GNOME_CFLAGS) \ - " - -LDFLAGS=" \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/libical.a \ - $(top_builddir)/libversit/.libs/libversit.al \ - " - -HTML_DIR=$(datadir)/gnome/html - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -tmpl_sources = \ - tmpl/cal-util.sgml \ - tmpl/evolution-cal-util-unused.sgml - -evolution_cal_util_docdir = $(HTML_DIR) -evolution_cal_util_doc_DATA = \ - evolution-cal-util.hierarchy \ - evolution-cal-util.types \ - evolution-cal-util-decl.txt \ - evolution-cal-util-sections.txt - -EXTRA_DIST = \ - $(evolution_cal_util_doc_DATA) - -sgml/evolution-cal-util-doc.bottom: $(tmpl_sources) - $(MAKE) sgml - -scan: - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="calobj.h icalendar-save.h icalendar.h" ) - -templates: scan - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - -sgml: - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) - -clean-local: - rm -f *~ *.bak *.signals *-unused.txt - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -dist-hook: - mkdir $(distdir)/sgml - mkdir $(distdir)/tmpl - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml - -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml - -.PHONY : sgml templates scan diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt deleted file mode 100644 index eb108b868f..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ /dev/null @@ -1,852 +0,0 @@ -<MACRO> -<NAME>CAL_COMPONENT_TYPE</NAME> -#define CAL_COMPONENT_TYPE (cal_component_get_type ()) -</MACRO> -<MACRO> -<NAME>CAL_COMPONENT</NAME> -#define CAL_COMPONENT(obj) (GTK_CHECK_CAST ((obj), CAL_COMPONENT_TYPE, CalComponent)) -</MACRO> -<MACRO> -<NAME>CAL_COMPONENT_CLASS</NAME> -#define CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_COMPONENT_TYPE, \ - CalComponentClass)) -</MACRO> -<MACRO> -<NAME>IS_CAL_COMPONENT</NAME> -#define IS_CAL_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), CAL_COMPONENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_CAL_COMPONENT_CLASS</NAME> -#define IS_CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_COMPONENT_TYPE)) -</MACRO> -<ENUM> -<NAME>CalComponentVType</NAME> -typedef enum { - CAL_COMPONENT_NO_TYPE, - CAL_COMPONENT_EVENT, - CAL_COMPONENT_TODO, - CAL_COMPONENT_JOURNAL, - CAL_COMPONENT_FREEBUSY, - CAL_COMPONENT_TIMEZONE -} CalComponentVType; -</ENUM> -<ENUM> -<NAME>CalComponentField</NAME> -typedef enum { - CAL_COMPONENT_FIELD_CATEGORIES, /* concatenation of the categories list */ - CAL_COMPONENT_FIELD_CLASSIFICATION, - CAL_COMPONENT_FIELD_COMPLETED, - CAL_COMPONENT_FIELD_DTEND, - CAL_COMPONENT_FIELD_DTSTART, - CAL_COMPONENT_FIELD_DUE, - CAL_COMPONENT_FIELD_GEO, - CAL_COMPONENT_FIELD_PERCENT, - CAL_COMPONENT_FIELD_PRIORITY, - CAL_COMPONENT_FIELD_SUMMARY, - CAL_COMPONENT_FIELD_TRANSPARENCY, - CAL_COMPONENT_FIELD_URL, - CAL_COMPONENT_FIELD_HAS_ALARMS, /* not a real field */ - CAL_COMPONENT_FIELD_ICON, /* not a real field */ - CAL_COMPONENT_FIELD_COMPLETE, /* not a real field */ - CAL_COMPONENT_FIELD_RECURRING, /* not a real field */ - CAL_COMPONENT_FIELD_OVERDUE, /* not a real field */ - CAL_COMPONENT_FIELD_COLOR, /* not a real field */ - CAL_COMPONENT_FIELD_NUM_FIELDS -} CalComponentField; -</ENUM> -<ENUM> -<NAME>CalComponentClassification</NAME> -typedef enum { - CAL_COMPONENT_CLASS_NONE, - CAL_COMPONENT_CLASS_PUBLIC, - CAL_COMPONENT_CLASS_PRIVATE, - CAL_COMPONENT_CLASS_CONFIDENTIAL, - CAL_COMPONENT_CLASS_UNKNOWN -} CalComponentClassification; -</ENUM> -<TYPEDEF> -<NAME>CalComponentDateTime</NAME> -typedef struct { - /* Actual date/time value */ - struct icaltimetype *value; - - /* Timezone ID */ - const char *tzid; -} CalComponentDateTime; -</TYPEDEF> -<ENUM> -<NAME>CalComponentPeriodType</NAME> -typedef enum { - CAL_COMPONENT_PERIOD_DATETIME, - CAL_COMPONENT_PERIOD_DURATION -} CalComponentPeriodType; -</ENUM> -<TYPEDEF> -<NAME>CalComponentPeriod</NAME> -typedef struct { - CalComponentPeriodType type; - - struct icaltimetype start; - - union { - struct icaltimetype end; - struct icaldurationtype duration; - } u; -} CalComponentPeriod; -</TYPEDEF> -<TYPEDEF> -<NAME>CalComponentText</NAME> -typedef struct { - /* Description string */ - const char *value; - - /* Alternate representation URI */ - const char *altrep; -} CalComponentText; -</TYPEDEF> -<ENUM> -<NAME>CalComponentTransparency</NAME> -typedef enum { - CAL_COMPONENT_TRANSP_NONE, - CAL_COMPONENT_TRANSP_TRANSPARENT, - CAL_COMPONENT_TRANSP_OPAQUE, - CAL_COMPONENT_TRANSP_UNKNOWN -} CalComponentTransparency; -</ENUM> -<STRUCT> -<NAME>CalComponentAlarm</NAME> -</STRUCT> -<STRUCT> -<NAME>CalComponent</NAME> -</STRUCT> -<STRUCT> -<NAME>CalComponentClass</NAME> -</STRUCT> -<STRUCT> -<NAME>CalComponentPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>CalComponent</NAME> -struct CalComponent { - GtkObject object; - - /* Private data */ - CalComponentPrivate *priv; -}; -</STRUCT> -<FUNCTION> -<NAME>cal_component_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_gen_uid</NAME> -<RETURNS>char *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_new</NAME> -<RETURNS>CalComponent *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_clone</NAME> -<RETURNS>CalComponent *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_new_vtype</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentVType type -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_icalcomponent</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp, icalcomponent *icalcomp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_icalcomponent</NAME> -<RETURNS>icalcomponent *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_vtype</NAME> -<RETURNS>CalComponentVType </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_as_string</NAME> -<RETURNS>char *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_commit_sequence</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_uid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **uid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_uid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *uid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_categories_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **categ_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_categories_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *categ_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_classification</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentClassification *classif -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_classification</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentClassification classif -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_comment_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_comment_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_completed</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype **t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_completed</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_created</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype **t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_created</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_description_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_description_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_dtend</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_dtend</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_dtstamp</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_dtstamp</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_dtstart</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_dtstart</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_due</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_due</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_exdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **exdate_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_exdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *exdate_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_exrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_exrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_geo</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icalgeotype **geo -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_geo</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icalgeotype *geo -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_last_modified</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype **t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_last_modified</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_percent</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int **percent -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_percent</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int *percent -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_priority</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int **priority -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_priority</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int *priority -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_rdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **period_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_rdate_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *period_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_rdates</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_rrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_rrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_rrules</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_sequence</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int **sequence -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_sequence</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, int *sequence -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_summary</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentText *summary -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_summary</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentText *summary -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_transparency</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentTransparency *transp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_transparency</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentTransparency transp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_url</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **url -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_url</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *url -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_pilot_id</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long *pilot_id -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_pilot_id</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long pilot_id -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_pilot_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long *pilot_status -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_pilot_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, unsigned long pilot_status -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_categories_list</NAME> -<RETURNS>void </RETURNS> -GSList *categ_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_datetime</NAME> -<RETURNS>void </RETURNS> -CalComponentDateTime *dt -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_exdate_list</NAME> -<RETURNS>void </RETURNS> -GSList *exdate_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_geo</NAME> -<RETURNS>void </RETURNS> -struct icalgeotype *geo -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_icaltimetype</NAME> -<RETURNS>void </RETURNS> -struct icaltimetype *t -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_percent</NAME> -<RETURNS>void </RETURNS> -int *percent -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_priority</NAME> -<RETURNS>void </RETURNS> -int *priority -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_period_list</NAME> -<RETURNS>void </RETURNS> -GSList *period_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_recur_list</NAME> -<RETURNS>void </RETURNS> -GSList *recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_sequence</NAME> -<RETURNS>void </RETURNS> -int *sequence -</FUNCTION> -<FUNCTION> -<NAME>cal_component_free_text_list</NAME> -<RETURNS>void </RETURNS> -GSList *text_list -</FUNCTION> -<ENUM> -<NAME>CalComponentAlarmAction</NAME> -typedef enum { - CAL_COMPONENT_ALARM_NONE, - CAL_COMPONENT_ALARM_AUDIO, - CAL_COMPONENT_ALARM_DISPLAY, - CAL_COMPONENT_ALARM_EMAIL, - CAL_COMPONENT_ALARM_PROCEDURE, - CAL_COMPONENT_ALARM_UNKNOWN -} CalComponentAlarmAction; -</ENUM> -<ENUM> -<NAME>CalComponentAlarmTriggerType</NAME> -typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATIVE, - CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE -} CalComponentAlarmTriggerType; -</ENUM> -<ENUM> -<NAME>CalComponentAlarmTriggerRelated</NAME> -typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATED_START, - CAL_COMPONENT_ALARM_TRIGGER_RELATED_END -} CalComponentAlarmTriggerRelated; -</ENUM> -<TYPEDEF> -<NAME>CalComponentAlarmTrigger</NAME> -typedef struct { - CalComponentAlarmTriggerType type; - - union { - struct { - struct icaldurationtype duration; - CalComponentAlarmTriggerRelated related; - } relative; - - struct icaltimetype absolute; - } u; -} CalComponentAlarmTrigger; -</TYPEDEF> -<FUNCTION> -<NAME>cal_component_get_first_alarm</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_next_alarm</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_free</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_action</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmAction *action -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_action</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmAction action -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmTrigger **trigger -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentAlarmTrigger *trigger -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_free_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarmTrigger *trigger -</FUNCTION> -<ENUM> -<NAME>CalRecurType</NAME> -typedef enum { - CAL_RECUR_YEARLY, - CAL_RECUR_MONTHLY, - CAL_RECUR_WEEKLY, - CAL_RECUR_DAILY, - CAL_RECUR_HOURLY, - CAL_RECUR_MINUTELY, - CAL_RECUR_SECONDLY -} CalRecurType; -</ENUM> -<TYPEDEF> -<NAME>CalRecurrence</NAME> -typedef struct { - CalRecurType type; - - int interval; - - /* Specifies the end of the recurrence. No occurrences are generated - after this date. If it is 0, the event recurs forever. */ - time_t enddate; - - /* WKST property - the week start day: 0 = Monday to 6 = Sunday. */ - gint week_start_day; - - - /* NOTE: I've used GList's here, but it doesn't matter if we use - other data structures like arrays. The code should be easy to - change. So long as it is easy to see if the modifier is set. */ - - /* For BYMONTH modifier. A list of GINT_TO_POINTERs, 0-11. */ - GList *bymonth; - - /* For BYWEEKNO modifier. A list of GINT_TO_POINTERs, [+-]1-53. */ - GList *byweekno; - - /* For BYYEARDAY modifier. A list of GINT_TO_POINTERs, [+-]1-366. */ - GList *byyearday; - - /* For BYMONTHDAY modifier. A list of GINT_TO_POINTERs, [+-]1-31. */ - GList *bymonthday; - - /* For BYDAY modifier. A list of GINT_TO_POINTERs, in pairs. - The first of each pair is the weekday, 0 = Monday to 6 = Sunday. - The second of each pair is the week number [+-]0-53. */ - GList *byday; - - /* For BYHOUR modifier. A list of GINT_TO_POINTERs, 0-23. */ - GList *byhour; - - /* For BYMINUTE modifier. A list of GINT_TO_POINTERs, 0-59. */ - GList *byminute; - - /* For BYSECOND modifier. A list of GINT_TO_POINTERs, 0-60. */ - GList *bysecond; - - /* For BYSETPOS modifier. A list of GINT_TO_POINTERs, +ve or -ve. */ - GList *bysetpos; -} CalRecurrence; -</TYPEDEF> -<STRUCT> -<NAME>CalObjTime</NAME> -</STRUCT> -<STRUCT> -<NAME>CalObjTime</NAME> -struct CalObjTime { - guint16 year; - guint8 month; /* 0 - 11 */ - guint8 day; /* 1 - 31 */ - guint8 hour; /* 0 - 23 */ - guint8 minute; /* 0 - 59 */ - guint8 second; /* 0 - 59 (maybe 60 for leap second) */ -}; -</STRUCT> -<USER_FUNCTION> -<NAME>CalRecurInstanceFn</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp, - time_t instance_start, - time_t instace_end, - gpointer data -</USER_FUNCTION> -<FUNCTION> -<NAME>cal_recur_generate_instances</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data -</FUNCTION> -<FUNCTION> -<NAME>cal_recur_from_icalrecurrencetype</NAME> -<RETURNS>CalRecurrence *</RETURNS> -struct icalrecurrencetype *ir -</FUNCTION> -<FUNCTION> -<NAME>cal_recur_free</NAME> -<RETURNS>void </RETURNS> -CalRecurrence *r -</FUNCTION> -<TYPEDEF> -<NAME>CalObjInstance</NAME> -typedef struct { - char *uid; /* UID of the object */ - time_t start; /* Start time of instance */ - time_t end; /* End time of instance */ -} CalObjInstance; -</TYPEDEF> -<FUNCTION> -<NAME>cal_obj_instance_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> -<TYPEDEF> -<NAME>CalAlarmInstance</NAME> -typedef struct { - char *uid; /* UID of object */ -#if 0 - enum AlarmType type; /* Type of alarm */ -#endif - time_t trigger; /* Alarm trigger time */ - time_t occur; /* Occurrence time */ -} CalAlarmInstance; -</TYPEDEF> -<FUNCTION> -<NAME>cal_alarm_instance_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> -<ENUM> -<NAME>CalObjType</NAME> -typedef enum { - CALOBJ_TYPE_EVENT = 1 << 0, - CALOBJ_TYPE_TODO = 1 << 1, - CALOBJ_TYPE_JOURNAL = 1 << 2, - CALOBJ_TYPE_ANY = 0x07 -} CalObjType; -</ENUM> -<FUNCTION> -<NAME>cal_obj_uid_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> -<FUNCTION> -<NAME>time_from_icaltimetype</NAME> -<RETURNS>time_t </RETURNS> -struct icaltimetype itt -</FUNCTION> -<FUNCTION> -<NAME>time_from_isodate</NAME> -<RETURNS>time_t </RETURNS> -char *str -</FUNCTION> -<FUNCTION> -<NAME>time_from_start_duration</NAME> -<RETURNS>time_t </RETURNS> -time_t start, char *duration -</FUNCTION> -<FUNCTION> -<NAME>isodate_from_time_t</NAME> -<RETURNS>char *</RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>get_time_t_hour</NAME> -<RETURNS>int </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>isodiff_to_secs</NAME> -<RETURNS>int </RETURNS> -char *str -</FUNCTION> -<FUNCTION> -<NAME>isodiff_from_secs</NAME> -<RETURNS>char *</RETURNS> -int secs -</FUNCTION> -<FUNCTION> -<NAME>time_add_minutes</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int minutes -</FUNCTION> -<FUNCTION> -<NAME>time_add_day</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int days -</FUNCTION> -<FUNCTION> -<NAME>time_add_week</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int weeks -</FUNCTION> -<FUNCTION> -<NAME>time_add_month</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int months -</FUNCTION> -<FUNCTION> -<NAME>time_add_year</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int years -</FUNCTION> -<FUNCTION> -<NAME>format_simple_hour</NAME> -<RETURNS>char *</RETURNS> -int hour, int use_am_pm -</FUNCTION> -<FUNCTION> -<NAME>time_days_in_month</NAME> -<RETURNS>int </RETURNS> -int year, int month -</FUNCTION> -<FUNCTION> -<NAME>time_from_day</NAME> -<RETURNS>time_t </RETURNS> -int year, int month, int day -</FUNCTION> -<FUNCTION> -<NAME>time_day_hour</NAME> -<RETURNS>time_t </RETURNS> -time_t t, int hour -</FUNCTION> -<FUNCTION> -<NAME>time_year_begin</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_year_end</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_month_begin</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_month_end</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_week_begin</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_week_end</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_day_begin</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_day_end</NAME> -<RETURNS>time_t </RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>parse_date</NAME> -<RETURNS>time_t </RETURNS> -char *str -</FUNCTION> -<FUNCTION> -<NAME>print_time_t</NAME> -<RETURNS>void </RETURNS> -time_t t -</FUNCTION> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt deleted file mode 100644 index cd928fc7e3..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ /dev/null @@ -1,166 +0,0 @@ -<SECTION> -<FILE>cal-component</FILE> -CAL_COMPONENT -<TITLE>CalComponent</TITLE> - -CalComponentVType -CalComponentField -CalComponentClassification -CalComponentDateTime -CalComponentPeriodType -CalComponentPeriod -CalComponentText -CalComponentTransparency -CalComponentAlarm -CalComponentPrivate - -cal_component_gen_uid -cal_component_new -cal_component_clone -cal_component_set_new_vtype -cal_component_set_icalcomponent -cal_component_get_icalcomponent -cal_component_get_vtype -cal_component_get_as_string -cal_component_commit_sequence -cal_component_get_uid -cal_component_set_uid -cal_component_get_categories_list -cal_component_set_categories_list -cal_component_get_classification -cal_component_set_classification -cal_component_get_comment_list -cal_component_set_comment_list -cal_component_get_completed -cal_component_set_completed -cal_component_get_created -cal_component_set_created -cal_component_get_description_list -cal_component_set_description_list -cal_component_get_dtend -cal_component_set_dtend -cal_component_get_dtstamp -cal_component_set_dtstamp -cal_component_get_dtstart -cal_component_set_dtstart -cal_component_get_due -cal_component_set_due -cal_component_get_exdate_list -cal_component_set_exdate_list -cal_component_get_exrule_list -cal_component_set_exrule_list -cal_component_get_geo -cal_component_set_geo -cal_component_get_last_modified -cal_component_set_last_modified -cal_component_get_percent -cal_component_set_percent -cal_component_get_priority -cal_component_set_priority -cal_component_get_rdate_list -cal_component_set_rdate_list -cal_component_has_rdates -cal_component_get_rrule_list -cal_component_set_rrule_list -cal_component_has_rrules -cal_component_get_sequence -cal_component_set_sequence -cal_component_get_summary -cal_component_set_summary -cal_component_get_transparency -cal_component_set_transparency -cal_component_get_url -cal_component_set_url -cal_component_get_pilot_id -cal_component_set_pilot_id -cal_component_get_pilot_status -cal_component_set_pilot_status - -cal_component_free_categories_list -cal_component_free_datetime -cal_component_free_exdate_list -cal_component_free_geo -cal_component_free_icaltimetype -cal_component_free_percent -cal_component_free_priority -cal_component_free_period_list -cal_component_free_recur_list -cal_component_free_sequence -cal_component_free_text_list - -CalComponentAlarmAction -CalComponentAlarmTriggerType -CalComponentAlarmTriggerRelated -CalComponentAlarmTrigger - -cal_component_get_first_alarm -cal_component_get_next_alarm -cal_component_alarm_free -cal_component_alarm_get_action -cal_component_alarm_set_action -cal_component_alarm_get_trigger -cal_component_alarm_set_trigger -cal_component_alarm_free_trigger - -<SUBSECTION Standard> -CAL_COMPONENT_TYPE -CAL_COMPONENT_CLASS -IS_CAL_COMPONENT -IS_CAL_COMPONENT_CLASS -cal_component_get_type - -<SUBSECTION Private> -CalComponent - -</SECTION> - -<SECTION> -<FILE>cal-recur</FILE> -CalRecurType -CalRecurrence -CalObjTime -CalRecurInstanceFn -cal_recur_generate_instances -cal_recur_from_icalrecurrencetype -cal_recur_free -</SECTION> - -<SECTION> -<FILE>cal-util</FILE> -CalObjInstance -cal_obj_instance_list_free -CalAlarmInstance -cal_alarm_instance_list_free -CalObjType -cal_obj_uid_list_free -</SECTION> - -<SECTION> -<FILE>timeutil</FILE> -time_from_icaltimetype -time_from_isodate -time_from_start_duration -isodate_from_time_t -get_time_t_hour -isodiff_to_secs -isodiff_from_secs -time_add_minutes -time_add_day -time_add_week -time_add_month -time_add_year -format_simple_hour -time_days_in_month -time_from_day -time_day_hour -time_year_begin -time_year_end -time_month_begin -time_month_end -time_week_begin -time_week_end -time_day_begin -time_day_end -parse_date -print_time_t -</SECTION> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.args b/doc/devel/calendar/cal-util/evolution-cal-util.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.args +++ /dev/null diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy b/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy deleted file mode 100644 index cc235653f2..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.hierarchy +++ /dev/null @@ -1,2 +0,0 @@ -GtkObject - CalComponent diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.signals b/doc/devel/calendar/cal-util/evolution-cal-util.signals deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.signals +++ /dev/null diff --git a/doc/devel/calendar/cal-util/evolution-cal-util.types b/doc/devel/calendar/cal-util/evolution-cal-util.types deleted file mode 100644 index 52b2d9bf90..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util.types +++ /dev/null @@ -1,4 +0,0 @@ -#include <gnome.h> -#include <cal-util/cal-component.h> - -cal_component_get_type diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml deleted file mode 100644 index 2f800e583f..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ /dev/null @@ -1,934 +0,0 @@ -<!-- ##### SECTION Title ##### --> -CalComponent - -<!-- ##### SECTION Short_Description ##### --> -RFC 2445 iCalendar component object. - -<!-- ##### SECTION Long_Description ##### --> - <para> - The #CalComponent object provides a wrapper over the &libical; - functions for manipulating calendar components. #CalComponent - presents a GTK+-like interface to calendar components according to - RFC 2445. - </para> - - <para> - While &libical; supports almost all of the features of the - iCalendar RFCs, applications are normally not interested in all - the mindless gunk that is there. Still, applications should do - their best not to drop extension fields from calendar components - or any other extra information they do not support (including - standard fields they are not interested in). The #CalComponent - object provides a wrapper over - <structname>icalcomponent</structname> structures from &libical; - so that no information in them will be lost even if the - application is not designed to handle it. Also, #CalComponent - provides a higher-level API to many of the &libical; operations so - as to make it less painful to deal with iCalendar components. - </para> - - <para> - A #CalComponent object starts out empty. It must be initialized - from an existing <structname>icalcomponent</structname> structure - by using the cal_component_set_icalcomponent() function, or from a - completely new data by specifying the desired component type to - the cal_component_set_new_vtype() function. - </para> - - <para> - #CalComponent will create an internal map of the properties in the - <structname>icalcomponent</structname> structure and then allow - random access to them via the #CalComponent API functions; - normally the &libical; API would have to be used by creating many - iterators and other unpleasant constructs. #CalComponent keeps - handles to the properties it scanned from the - <structname>icalcomponent</structname> and will let the parent - application modify them at any time without having to do any - iteration. - </para> - - <para> - Eventually a #CalComponent may be turned into the RFC 2445 string - representation of an iCalendar component by using the - cal_component_get_as_string() function. Applications can then - transfer this interoperable - <footnote> - <para> - “Interoperable.” Heavens, I love that word. - </para> - </footnote> - string to other programs that deal with iCalendar. - </para> - -<!-- ##### SECTION See_Also ##### --> - <para> - - </para> - -<!-- ##### MACRO CAL_COMPONENT ##### --> - <para> - Casts a #GtkObject to a #CalComponent. - </para> - -@obj: A GTK+ object. - - -<!-- ##### ENUM CalComponentVType ##### --> - <para> - Calendar component types as defined by RFC 2445. These values can - be used to create a new calendar component by passing them to the - cal_component_set_new_vtype() function. They are also the return - value of the cal_component_get_vtype() function. The only time - the @CAL_COMPONENT_NO_TYPE value is used is when querying the - vtype of an uninitialized #CalComponent. - </para> - -@CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to - indicate an uninitialized #CalComponent object. - -@CAL_COMPONENT_EVENT: Indicates a VEVENT component. -@CAL_COMPONENT_TODO: Indicates a VTODO component. -@CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component. -@CAL_COMPONENT_FREEBUSY: Indicates a VFREEBUSY component. -@CAL_COMPONENT_TIMEZONE: Indicates a VTIMEZOME component. - -<!-- ##### ENUM CalComponentField ##### --> - <para> - These values are used as identifiers for #ETable columns. These - are used by the calendar GUI code in Evolution. - </para> - -@CAL_COMPONENT_FIELD_CATEGORIES: Component's list of categories. -@CAL_COMPONENT_FIELD_CLASSIFICATION: Component's classification. -@CAL_COMPONENT_FIELD_COMPLETED: Component's completion date. -@CAL_COMPONENT_FIELD_DTEND: Component's ending date. -@CAL_COMPONENT_FIELD_DTSTART: Component's starting date. -@CAL_COMPONENT_FIELD_DUE: Component's due date. -@CAL_COMPONENT_FIELD_GEO: Component's geographical position. -@CAL_COMPONENT_FIELD_PERCENT: Component's percent completed value. -@CAL_COMPONENT_FIELD_PRIORITY: Component's priority. -@CAL_COMPONENT_FIELD_SUMMARY: Component's summary. -@CAL_COMPONENT_FIELD_TRANSPARENCY: Component's transparency value. -@CAL_COMPONENT_FIELD_URL: Component's URL. -@CAL_COMPONENT_FIELD_HAS_ALARMS: Whether the component has any alarms. -@CAL_COMPONENT_FIELD_ICON: Which icon to use for the component. -@CAL_COMPONENT_FIELD_COMPLETE: Whether the component has been completed. -@CAL_COMPONENT_FIELD_RECURRING: Whether the component has any recurrences. -@CAL_COMPONENT_FIELD_OVERDUE: Whether the component is overdue. -@CAL_COMPONENT_FIELD_COLOR: Which color to use for the component. -@CAL_COMPONENT_FIELD_NUM_FIELDS: Total number of enumerated fields. - -<!-- ##### ENUM CalComponentClassification ##### --> - <para> - Values for the access classification property of a calendar - component. - </para> - -@CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has - been set for the corresponding component. - -@CAL_COMPONENT_CLASS_PUBLIC: Public access. -@CAL_COMPONENT_CLASS_PRIVATE: Private access. -@CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access. - -@CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value, - used when &libical; returns something #CalComponent does not know - about. - -<!-- ##### TYPEDEF CalComponentDateTime ##### --> - <para> - This structure defines a date and time value. - </para> - - -<!-- ##### ENUM CalComponentPeriodType ##### --> - <para> - Defines how a period of time is specified. - </para> - -@CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified - by starting and ending date/time values. - -@CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified - as a starding date/time and a duration value. - -<!-- ##### TYPEDEF CalComponentPeriod ##### --> - <para> - This structure defines a period of time. - </para> - - -<!-- ##### TYPEDEF CalComponentText ##### --> - <para> - This structure defines the value of a text property that may have - an alternate representation parameter. - </para> - - -<!-- ##### ENUM CalComponentTransparency ##### --> -<para> - -</para> - -@CAL_COMPONENT_TRANSP_NONE: -@CAL_COMPONENT_TRANSP_TRANSPARENT: -@CAL_COMPONENT_TRANSP_OPAQUE: -@CAL_COMPONENT_TRANSP_UNKNOWN: - -<!-- ##### STRUCT CalComponentAlarm ##### --> -<para> - -</para> - - -<!-- ##### STRUCT CalComponentPrivate ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_component_gen_uid ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_component_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_component_clone ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_set_new_vtype ##### --> -<para> - -</para> - -@comp: -@type: - - -<!-- ##### FUNCTION cal_component_set_icalcomponent ##### --> -<para> - -</para> - -@comp: -@icalcomp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_icalcomponent ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_vtype ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_as_string ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_commit_sequence ##### --> -<para> - -</para> - -@comp: - - -<!-- ##### FUNCTION cal_component_get_uid ##### --> -<para> - -</para> - -@comp: -@uid: - - -<!-- ##### FUNCTION cal_component_set_uid ##### --> -<para> - -</para> - -@comp: -@uid: - - -<!-- ##### FUNCTION cal_component_get_categories_list ##### --> -<para> - -</para> - -@comp: -@categ_list: - - -<!-- ##### FUNCTION cal_component_set_categories_list ##### --> -<para> - -</para> - -@comp: -@categ_list: - - -<!-- ##### FUNCTION cal_component_get_classification ##### --> -<para> - -</para> - -@comp: -@classif: - - -<!-- ##### FUNCTION cal_component_set_classification ##### --> -<para> - -</para> - -@comp: -@classif: - - -<!-- ##### FUNCTION cal_component_get_comment_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_set_comment_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_get_completed ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_completed ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_created ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_created ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_description_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_set_description_list ##### --> -<para> - -</para> - -@comp: -@text_list: - - -<!-- ##### FUNCTION cal_component_get_dtend ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_set_dtend ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_get_dtstamp ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_dtstamp ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_dtstart ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_set_dtstart ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_get_due ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_set_due ##### --> -<para> - -</para> - -@comp: -@dt: - - -<!-- ##### FUNCTION cal_component_get_exdate_list ##### --> -<para> - -</para> - -@comp: -@exdate_list: - - -<!-- ##### FUNCTION cal_component_set_exdate_list ##### --> -<para> - -</para> - -@comp: -@exdate_list: - - -<!-- ##### FUNCTION cal_component_get_exrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_set_exrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_get_geo ##### --> -<para> - -</para> - -@comp: -@geo: - - -<!-- ##### FUNCTION cal_component_set_geo ##### --> -<para> - -</para> - -@comp: -@geo: - - -<!-- ##### FUNCTION cal_component_get_last_modified ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_set_last_modified ##### --> -<para> - -</para> - -@comp: -@t: - - -<!-- ##### FUNCTION cal_component_get_percent ##### --> -<para> - -</para> - -@comp: -@percent: - - -<!-- ##### FUNCTION cal_component_set_percent ##### --> -<para> - -</para> - -@comp: -@percent: - - -<!-- ##### FUNCTION cal_component_get_priority ##### --> -<para> - -</para> - -@comp: -@priority: - - -<!-- ##### FUNCTION cal_component_set_priority ##### --> -<para> - -</para> - -@comp: -@priority: - - -<!-- ##### FUNCTION cal_component_get_rdate_list ##### --> -<para> - -</para> - -@comp: -@period_list: - - -<!-- ##### FUNCTION cal_component_set_rdate_list ##### --> -<para> - -</para> - -@comp: -@period_list: - - -<!-- ##### FUNCTION cal_component_has_rdates ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_rrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_set_rrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_has_rrules ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_sequence ##### --> -<para> - -</para> - -@comp: -@sequence: - - -<!-- ##### FUNCTION cal_component_set_sequence ##### --> -<para> - -</para> - -@comp: -@sequence: - - -<!-- ##### FUNCTION cal_component_get_summary ##### --> -<para> - -</para> - -@comp: -@summary: - - -<!-- ##### FUNCTION cal_component_set_summary ##### --> -<para> - -</para> - -@comp: -@summary: - - -<!-- ##### FUNCTION cal_component_get_transparency ##### --> -<para> - -</para> - -@comp: -@transp: - - -<!-- ##### FUNCTION cal_component_set_transparency ##### --> -<para> - -</para> - -@comp: -@transp: - - -<!-- ##### FUNCTION cal_component_get_url ##### --> -<para> - -</para> - -@comp: -@url: - - -<!-- ##### FUNCTION cal_component_set_url ##### --> -<para> - -</para> - -@comp: -@url: - - -<!-- ##### FUNCTION cal_component_get_pilot_id ##### --> -<para> - -</para> - -@comp: -@pilot_id: - - -<!-- ##### FUNCTION cal_component_set_pilot_id ##### --> -<para> - -</para> - -@comp: -@pilot_id: - - -<!-- ##### FUNCTION cal_component_get_pilot_status ##### --> -<para> - -</para> - -@comp: -@pilot_status: - - -<!-- ##### FUNCTION cal_component_set_pilot_status ##### --> -<para> - -</para> - -@comp: -@pilot_status: - - -<!-- ##### FUNCTION cal_component_free_categories_list ##### --> -<para> - -</para> - -@categ_list: - - -<!-- ##### FUNCTION cal_component_free_datetime ##### --> -<para> - -</para> - -@dt: - - -<!-- ##### FUNCTION cal_component_free_exdate_list ##### --> -<para> - -</para> - -@exdate_list: - - -<!-- ##### FUNCTION cal_component_free_geo ##### --> -<para> - -</para> - -@geo: - - -<!-- ##### FUNCTION cal_component_free_icaltimetype ##### --> -<para> - -</para> - -@t: - - -<!-- ##### FUNCTION cal_component_free_percent ##### --> -<para> - -</para> - -@percent: - - -<!-- ##### FUNCTION cal_component_free_priority ##### --> -<para> - -</para> - -@priority: - - -<!-- ##### FUNCTION cal_component_free_period_list ##### --> -<para> - -</para> - -@period_list: - - -<!-- ##### FUNCTION cal_component_free_recur_list ##### --> -<para> - -</para> - -@recur_list: - - -<!-- ##### FUNCTION cal_component_free_sequence ##### --> -<para> - -</para> - -@sequence: - - -<!-- ##### FUNCTION cal_component_free_text_list ##### --> -<para> - -</para> - -@text_list: - - -<!-- ##### ENUM CalComponentAlarmAction ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_NONE: -@CAL_COMPONENT_ALARM_AUDIO: -@CAL_COMPONENT_ALARM_DISPLAY: -@CAL_COMPONENT_ALARM_EMAIL: -@CAL_COMPONENT_ALARM_PROCEDURE: -@CAL_COMPONENT_ALARM_UNKNOWN: - -<!-- ##### ENUM CalComponentAlarmTriggerType ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: - -<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: - -<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_component_get_first_alarm ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_next_alarm ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_alarm_free ##### --> -<para> - -</para> - -@alarm: - - -<!-- ##### FUNCTION cal_component_alarm_get_action ##### --> -<para> - -</para> - -@alarm: -@action: - - -<!-- ##### FUNCTION cal_component_alarm_set_action ##### --> -<para> - -</para> - -@alarm: -@action: - - -<!-- ##### FUNCTION cal_component_alarm_get_trigger ##### --> -<para> - -</para> - -@alarm: -@trigger: - - -<!-- ##### FUNCTION cal_component_alarm_set_trigger ##### --> -<para> - -</para> - -@alarm: -@trigger: - - -<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### --> -<para> - -</para> - -@trigger: - - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") -End: ---> diff --git a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml deleted file mode 100644 index 703f8b2b85..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ /dev/null @@ -1,88 +0,0 @@ -<!-- ##### SECTION Title ##### --> -cal-recur - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### ENUM CalRecurType ##### --> -<para> - -</para> - -@CAL_RECUR_YEARLY: -@CAL_RECUR_MONTHLY: -@CAL_RECUR_WEEKLY: -@CAL_RECUR_DAILY: -@CAL_RECUR_HOURLY: -@CAL_RECUR_MINUTELY: -@CAL_RECUR_SECONDLY: - -<!-- ##### TYPEDEF CalRecurrence ##### --> -<para> - -</para> - - -<!-- ##### STRUCT CalObjTime ##### --> -<para> - -</para> - -@year: -@month: -@day: -@hour: -@minute: -@second: - -<!-- ##### USER_FUNCTION CalRecurInstanceFn ##### --> -<para> - -</para> - -@comp: -@instance_start: -@instace_end: -@data: -@Returns: - - -<!-- ##### FUNCTION cal_recur_generate_instances ##### --> -<para> - -</para> - -@comp: -@start: -@end: -@cb: -@cb_data: - - -<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### --> -<para> - -</para> - -@ir: -@Returns: - - -<!-- ##### FUNCTION cal_recur_free ##### --> -<para> - -</para> - -@r: - - diff --git a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml deleted file mode 100644 index 8d4516c2ec..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml +++ /dev/null @@ -1,62 +0,0 @@ -<!-- ##### SECTION Title ##### --> -cal-util - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### TYPEDEF CalObjInstance ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_obj_instance_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### TYPEDEF CalAlarmInstance ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_alarm_instance_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### ENUM CalObjType ##### --> -<para> - -</para> - -@CALOBJ_TYPE_EVENT: -@CALOBJ_TYPE_TODO: -@CALOBJ_TYPE_JOURNAL: -@CALOBJ_TYPE_ANY: - -<!-- ##### FUNCTION cal_obj_uid_list_free ##### --> -<para> - -</para> - -@list: - - diff --git a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ /dev/null diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml deleted file mode 100644 index 3b62fbba3f..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml +++ /dev/null @@ -1,260 +0,0 @@ -<!-- ##### SECTION Title ##### --> -timeutil - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### FUNCTION time_from_icaltimetype ##### --> -<para> - -</para> - -@itt: -@Returns: - - -<!-- ##### FUNCTION time_from_isodate ##### --> -<para> - -</para> - -@str: -@Returns: - - -<!-- ##### FUNCTION time_from_start_duration ##### --> -<para> - -</para> - -@start: -@duration: -@Returns: - - -<!-- ##### FUNCTION isodate_from_time_t ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION get_time_t_hour ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION isodiff_to_secs ##### --> -<para> - -</para> - -@str: -@Returns: - - -<!-- ##### FUNCTION isodiff_from_secs ##### --> -<para> - -</para> - -@secs: -@Returns: - - -<!-- ##### FUNCTION time_add_minutes ##### --> -<para> - -</para> - -@time: -@minutes: -@Returns: - - -<!-- ##### FUNCTION time_add_day ##### --> -<para> - -</para> - -@time: -@days: -@Returns: - - -<!-- ##### FUNCTION time_add_week ##### --> -<para> - -</para> - -@time: -@weeks: -@Returns: - - -<!-- ##### FUNCTION time_add_month ##### --> -<para> - -</para> - -@time: -@months: -@Returns: - - -<!-- ##### FUNCTION time_add_year ##### --> -<para> - -</para> - -@time: -@years: -@Returns: - - -<!-- ##### FUNCTION format_simple_hour ##### --> -<para> - -</para> - -@hour: -@use_am_pm: -@Returns: - - -<!-- ##### FUNCTION time_days_in_month ##### --> -<para> - -</para> - -@year: -@month: -@Returns: - - -<!-- ##### FUNCTION time_from_day ##### --> -<para> - -</para> - -@year: -@month: -@day: -@Returns: - - -<!-- ##### FUNCTION time_day_hour ##### --> -<para> - -</para> - -@t: -@hour: -@Returns: - - -<!-- ##### FUNCTION time_year_begin ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_year_end ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_month_begin ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_month_end ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_week_begin ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_week_end ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_day_begin ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_day_end ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION parse_date ##### --> -<para> - -</para> - -@str: -@Returns: - - -<!-- ##### FUNCTION print_time_t ##### --> -<para> - -</para> - -@t: - - diff --git a/doc/devel/calendar/evolution-calendar.sgml b/doc/devel/calendar/evolution-calendar.sgml deleted file mode 100644 index f3936d9bbc..0000000000 --- a/doc/devel/calendar/evolution-calendar.sgml +++ /dev/null @@ -1,51 +0,0 @@ - <part> - <docinfo> - <authorgroup> - <author> - <firstname>Federico</firstname> - <surname>Mena Quintero</surname> - <affiliation> - <address> - <email>federico@helixcode.com</email> - </address> - </affiliation> - </author> - </authorgroup> - </docinfo> - - <title>Developing Applications for the Evolution Calendar</title> - - <partintro> - <para> - This part of the Evolution Developer's Guide describes how to - write applications for the Evolution Calendar by using its - public interfaces. The Evolution Calendar exports its - functionality through a number of interfaces, including CORBA, - GTK+ wrappers for Bonobo objects, and other utility libraries. - </para> - - <para> - You should read this part of the Evolution Developer's guide - if you intend to write client applications that use the - functionality of the Evolution Calendar. - </para> - - <para> - This part does not describe the internal interfaces of the - Evolution Calendar; for that you should read the Evolution - Internals Guide. You should only need to read that guide if - you are interested in the way the calendar works internally or - if you want to make changes directly to the Evolution Calendar - code. - </para> - </partintro> - - &calendar-architecture; - </part> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "book" "") -End: ---> diff --git a/doc/devel/calendar/public-reference.sgml b/doc/devel/calendar/public-reference.sgml deleted file mode 100644 index f8aa6e848d..0000000000 --- a/doc/devel/calendar/public-reference.sgml +++ /dev/null @@ -1,24 +0,0 @@ - <reference> - <title>Calendar Public API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - public APIs of the different components of the Evolution - Calendar. - </para> - </partintro> - - &CalClient; - &CalComponent; - &cal-util; - &cal-recur; - &timeutil; - </reference> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/calendar/reference.sgml b/doc/devel/calendar/reference.sgml deleted file mode 100644 index f8aa6e848d..0000000000 --- a/doc/devel/calendar/reference.sgml +++ /dev/null @@ -1,24 +0,0 @@ - <reference> - <title>Calendar Public API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - public APIs of the different components of the Evolution - Calendar. - </para> - </partintro> - - &CalClient; - &CalComponent; - &cal-util; - &cal-recur; - &timeutil; - </reference> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/evolution-devel-guide.sgml b/doc/devel/evolution-devel-guide.sgml deleted file mode 100644 index ca80ec533a..0000000000 --- a/doc/devel/evolution-devel-guide.sgml +++ /dev/null @@ -1,50 +0,0 @@ -<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!entity evolution-calendar SYSTEM "calendar/evolution-calendar.sgml"> -<!entity calendar-architecture SYSTEM "calendar/architecture.sgml"> -<!entity calendar-reference SYSTEM "calendar/reference.sgml"> -<!entity CalClient SYSTEM "calendar/cal-client/sgml/cal-client.sgml"> -<!entity CalComponent SYSTEM "calendar/cal-util/sgml/cal-component.sgml"> -<!entity cal-util SYSTEM "calendar/cal-util/sgml/cal-util.sgml"> -<!entity cal-recur SYSTEM "calendar/cal-util/sgml/cal-recur.sgml"> -<!entity timeutil SYSTEM "calendar/cal-util/sgml/timeutil.sgml"> -<!entity PCS "<acronym>PCS</acronym>"> -<!entity libical "<application>libical</application>"> -]> - -<book> - <bookinfo> - <title>Evolution Developer's Guide</title> - - <authorgroup> - <corpauthor> - Helix Code, Inc. - </corpauthor> - </authorgroup> - - <copyright> - <year>2000</year> - <holder>Helix Code, Inc.</holder> - </copyright> - </bookinfo> - - <!-- DocBook parts for each individual component --> - - &evolution-calendar; - - <!-- API Reference part --> - - <part> - <title>Evolution Public API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - different libraries and interfaces that Evolution provides. - Classes are described together with their methods; individual - functions are grouped by functional group. - </para> - </partintro> - - &calendar-reference; - </part> -</book> 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> |
