diff options
| author | nobody <nobody@localhost> | 2001-12-14 12:59:04 +0800 |
|---|---|---|
| committer | nobody <nobody@localhost> | 2001-12-14 12:59:04 +0800 |
| commit | 5885b7cc50cf1357a480845fb4394c67b2f062eb (patch) | |
| tree | 32cb6f4702fe446ea804947fa4479b5431a3d24a /doc | |
| parent | 969ffa703d70be312a9b9b2f7a6d2b7a8ac87c17 (diff) | |
| download | gsoc2013-evolution-BONOBO_1_0_18.tar.gz gsoc2013-evolution-BONOBO_1_0_18.tar.zst gsoc2013-evolution-BONOBO_1_0_18.zip | |
This commit was manufactured by cvs2svn to create tagBONOBO_1_0_18
'BONOBO_1_0_18'.
svn path=/tags/BONOBO_1_0_18/; revision=15038
Diffstat (limited to 'doc')
74 files changed, 0 insertions, 10347 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/COPYING-DOCS b/doc/COPYING-DOCS deleted file mode 100644 index b42936beb3..0000000000 --- a/doc/COPYING-DOCS +++ /dev/null @@ -1,355 +0,0 @@ - GNU Free Documentation License - Version 1.1, March 2000 - - Copyright (C) 2000 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. - - -0. PREAMBLE - -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. - -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. - -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. - - -1. APPLICABILITY AND DEFINITIONS - -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 "Document", below, refers to any -such manual or work. Any member of the public is a licensee, and is -addressed as "you". - -A "Modified Version" 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. - -A "Secondary Section" is a named appendix or a front-matter section of -the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall subject -(or to related matters) and contains nothing that could fall directly -within that overall subject. (For example, if the Document is in part a -textbook of mathematics, a Secondary Section 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. - -The "Invariant Sections" are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. - -The "Cover Texts" are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. - -A "Transparent" copy of the Document 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 Transparent file -format whose markup has been designed to thwart or discourage -subsequent modification by readers is not Transparent. A copy that is -not "Transparent" is called "Opaque". - -Examples of suitable formats for Transparent 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. - -The "Title Page" 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, "Title Page" means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - - -2. VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document 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 section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - - -3. COPYING IN QUANTITY - -If you publish printed copies of the Document numbering more than 100, -and the Document's license notice requires Cover Texts, you must enclose -the copies in covers that carry, clearly and legibly, all these Cover -Texts: 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 Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -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. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a publicly-accessible computer-network location containing a complete -Transparent copy of the Document, 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 Opaque copies in quantity, to ensure that this -Transparent copy will remain thus accessible at the stated location -until at least one year after the last time you distribute an Opaque -copy (directly or through your agents or retailers) of that edition to -the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. - - -4. MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -A. Use in the Title Page (and on the covers, if any) a title distinct - from that of the Document, and from those of previous versions - (which should, if there were any, be listed in the History section - of the Document). You may use the same title as a previous version - if the original publisher of that version gives permission. -B. List on the Title Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the Modified - Version, together with at least five of the principal authors of the - Document (all of its principal authors, if it has less than five). -C. State on the Title page the name of the publisher of the - Modified Version, as the publisher. -D. Preserve all the copyright notices of the Document. -E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. -F. Include, immediately after the copyright notices, a license notice - giving the public permission to use the Modified Version under the - terms of this License, in the form shown in the Addendum below. -G. Preserve in that license notice the full lists of Invariant Sections - and required Cover Texts given in the Document's license notice. -H. Include an unaltered copy of this License. -I. 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 Modified Version as given on the Title Page. If - there is no section entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. -J. Preserve the network location, if any, given in the Document for - public access to a Transparent copy of the Document, and likewise - the network locations given in the Document 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 Document itself, or if the original - publisher of the version it refers to gives permission. -K. 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. -L. Preserve all the Invariant Sections of the Document, - unaltered in their text and in their titles. Section numbers - or the equivalent are not considered part of the section titles. -M. Delete any section entitled "Endorsements". Such a section - may not be included in the Modified Version. -N. Do not retitle any existing section as "Endorsements" - or to conflict in title with any Invariant Section. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections 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 Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version 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. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document 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. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - - -5. COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections 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 -Invariant Sections in the license notice of the combined work. - -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." - - -6. COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document 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. - -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. - - -7. AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document 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 Modified Version -of the Document, 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 Document, on account of their being thus compiled, if they -are not themselves derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one quarter -of the entire aggregate, the Document's Cover Texts may be placed on -covers that surround only the Document within the aggregate. -Otherwise they must appear on covers around the whole aggregate. - - -8. TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. 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. - - -9. TERMINATION - -You may not copy, modify, sublicense, or distribute the Document except -as expressly provided for under this License. Any other attempt to -copy, modify, sublicense or distribute the Document 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. - - -10. FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation 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 -http://www.gnu.org/copyleft/. - -Each version of the License is given a distinguishing version number. -If the Document 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 Document 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. - - -ADDENDUM: How to use this License for your documents - -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: - - Copyright (c) YEAR YOUR NAME. - 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 Invariant Sections being LIST THEIR TITLES, with the - Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. - A copy of the license is included in the section entitled "GNU - Free Documentation License". - -If you have no Invariant Sections, write "with no Invariant Sections" -instead of saying which ones are invariant. If you have no -Front-Cover Texts, write "no Front-Cover Texts" instead of -"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. - -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 GNU General Public License, -to permit their use in free software. diff --git a/doc/Camel-Classes b/doc/Camel-Classes deleted file mode 100644 index 8b510dad7a..0000000000 --- a/doc/Camel-Classes +++ /dev/null @@ -1,65 +0,0 @@ -CamelException -CamelLock -CamelLockClient -CamelLockHelper -CamelMovemail -CamelOperation -CamelProvider -CamelUIDCache -CamelURL -CamelObject - + CamelAddress - | + CamelInternetAddress - | ` CamelNewsAddress - + CamelDataWrapper - | + CamelMedium - | | ` CamelMimePart - | | ` CamelMimeMessage - | ` CamelMultipart - + CamelCipherContext - | ` CamelPgpContext - + CamelCMSContext - | ` CamelSMimeContext - + CamelDiscoDiary - + CamelFolder - | + CamelDiscoFolder - | ` CamelVeeFolder - | ` CamelVTrashFolder - + CamelFolderSearch - + CamelFolderSummary - + CamelMimeFilter - | + CamelMimeFilterBasic - | + CamelMimeFilterBestenc - | + CamelMimeFilterCharset - | + CamelMimeFilterCRLF - | + CamelMimeFilterFrom - | + CamelMimeFilterIndex - | + CamelMimeFilterLinewrap - | + CamelMimeFilterSave - | ` CamelMimeFilterStripHeader - + CamelSasl - | + CamelSaslAnonymous - | + CamelSaslCramMD5 - | + CamelSaslDigestMD5 - | + CamelSaslKerberos - | + CamelSaslLogin - | ` CamelSaslPlain - + CamelService - | + CamelStore - | | + CamelRemoteStore - | | | ` CamelDiscoStore - | | ` CamelVeeStore - | ` CamelTransport - + CamelSession - ` CamelStream - + CamelSeekableStream - | + CamelSeekableSubstream - | + CamelStreamFs - | ` CamelStreamMem - + CamelStreamBuffer - + CamelStreamFilter - + CamelStreamNull - ` CamelTcpStream - + CamelTcpStreamOpenSSL - + CamelTcpStreamRaw - ` CamelTcpStreamSSL diff --git a/doc/ChangeLog b/doc/ChangeLog deleted file mode 100644 index e7dd37db31..0000000000 --- a/doc/ChangeLog +++ /dev/null @@ -1,1146 +0,0 @@ -2001-08-16 Kjartan Maraas <kmaraas@gnome.org> - - * C/Makefile.am: Small fix to build. - * C/evolution-C.omf: Small fix. Remove an extra space. - * no/Makefile.am: Same here. - * no/evolution-no.omf: And here. - -2001-08-15 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Updated one line about bullet points. - -2001-08-15 Kjartan Maraas <kmaraas@gnome.org> - - * no/*: Added beginnings of a Norwegian translation. - * sgmldocs.make: Forgot to add this. Kinda important. - * C/*.sgml: s/fig/figures/ - * C/Makefile.am: Make it use the sgmldocs.make framework. - -2001-08-14 Aaron Weber <aaron@ximian.com> - - * C/usage-mainwindow.sgml: Commented out menuref. - * C/usage-contact.sgml: Commented out menuref. - * C/evolution.sgml: commented out menuref. - * C/preface.sgml: commented out menuref. - -2001-08-12 Kjartan Maraas <kmaraas@gnome.org> - - * C/apx-authors.sgml: Added missing ;'s after entities. - * C/evolution-C.omf: s/en/C in Language. - * C/usage-mail-org.sgml: Add missing ;. - * C/usage-mainwindow.sgml: Same here. - -2001-08-10 Aaron Weber <aaron@ximian.com> - - * C/usage-mail.sgml: Switched all images in entire document to - *not* use file extensions, so that they work properly with - db2ps. This doesn't completely fix the db2ps issues, but it's - apparently the right way to do this. - -2001-08-09 Aaron Weber <aaron@ximian.com> - - * C/config-prefs.sgml: Made sharing tip an orderedlist. - -2001-08-08 Kevin Breit <battery841@mediaone.net> - - * C/config-prefs.sgml: Add information about sharing mailbox files. - -2001-08-03 Kevin Breit <battery841@mediaone.net> - - * C/usage-calendar.sgml: Add information about gathering actions. - -2001-08-02 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Added a <tip> for scrolling through mails. - -2001-07-30 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Fixed some breakage Aaron caused. - -2001-07-26 Aaron Weber <aaron@ximian.com> - - * C/usage-mail-org.sgml: revised. - - * C/usage-mail.sgml: revisions and stuff. - -2001-07-24 Aaron Weber <aaron@ximian.com> - - * C/evolution-faq.sgml: Reworded a few questions. - -2001-07-23 Kevin Breit <battery841@mediaone.net> - - * C/Makefile.am: Pulled instance of config-setupassist.sgml to make stuff build right. - -2001-07-23 Aaron Weber <aaron@ximian.com> - - * C/usage-mainwindow.sgml: validated. - - * C/config-setupassist.sgml: Removed. - - * C/evolution.sgml: removed config-setupassist. - - * C/usage-exec-summary.sgml: Minor revisions. - - * C/usage-contact.sgml: Added 'format="png"' to all <image> tags - missing the attribute. - - * C/usage-calendar.sgml: Added 'format="png"' to all <image> tags - missing the attribute. - - * C/usage-mail.sgml: Added 'format="png"' to all <image> tags - missing the attribute. - - * C/usage-mainwindow.sgml: Style. Merged info from preface. Added - 'format="png"' to all <image> tags missing the attribute. - - * C/preface.sgml: Style changes. Removed info that was duplicated - in mainwindow.sgml. - -2001-07-20 Kevin Breit <battery841@mediaone.net> - - * C/usage-mainwindow.sgml: Fixed the first time druid stuff a little more. - -2001-07-16 Aaron Weber <aaron@ximian.com> - - * C/evolution-faq.sgml: Sepllcheck. - -2001-07-15 Kevin Breit <battery841@mediaone.net> - - * C/config-sync.sgml: Updated slightly for new design. - -2001-07-13 Kevin Breit <battery841@mediaone.net> - - * C/usage-mainwindow.sgml: Added lots of good stuff with the first time druid. - -2001-07-12 Aaron Weber <aaron@ximian.com> - - * C/evolution-faq.sgml: TYPO fixing. - -2001-07-12 Aaron Weber <aaron@ximian.com> - - * C/evolution-faq.sgml: Added "get bt for component-only crash" qandaentry. - -2001-07-10 Peter Williams <peterw@ximian.com> - - * */Makefile.am (dist-hook): Clean up make dist. - -2001-07-11 Aaron Weber <aaron@ximian.com> - - * C/evolution.sgml: validation on usage-mainwindow and usage-contact. - -2001-07-11 Kevin Breit <battery841@mediaone.net> - - * C/usage-calendar.sgml: More edits. - - * C/usage-contact.sgml: Sick amounts of changes too! - - * C/usage-mail-org.sgml: Heavy editing...touched almost everything. - - * C/usage-exec-summary.sgml: Minor change. There was only one change for this chapter, cuz I'm such a 'godly' writer...yeah. - - * C/usage-mainwindow.sgml: A bit of editing. - - * C/preface.sgml: Screwed with the examples and did some cleanup. - -2001-07-10 Aaron Weber <aaron@ximian.com> - - * C/usage-mail-org.sgml: validation. - -2001-07-10 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Added <application> tags - - * C/usage-mail-org.sgml: Added <application> tags - - * C/config-prefs.sgml: Added <application> tags - -2001-07-09 Kevin Breit <battery841@mediaone.net> - - * C/usage-exec-summary.sgml: Editing - - * C/usage-mail.sgml: Editing - - * C/usage-mail-org.sgml: Editing - - * C/usage-calendar.sgml: Editing - - * C/usage-contact.sgml: Editing - - * C/usage-mail-org.sgml: Mention UNMATCHED - - * C/usage-mail.sgml: Commented on trash being a vFolder - -2001-07-06 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Spell check - - * C/usage-calendar.sgml: Spell check - -2001-07-05 Kevin Breit <battery841@mediaone.net> - - * C/usage-mainwindow.sgml: Added orderedlists. - - * C/usage-exec-summary.sgml: Added orderedlists. - - * C/usage-contact.sgml: Added orderedlists. - - * C/usage-mail-org.sgml: Added orderedlists. - -2001-07-03 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Put in lots of orderedlists...more SGML, less - for the user to read. They'll thank me in droves later. - - * C/usage-exec-summary.sgml: Fixed build error - -2001-06-29 Jeffrey Stedfast <fejj@ximian.com> - - * white-papers/mail/camel.sgml: Updated slightly. - - * Camel-Classes: Updated. - -2001-07-02 Kevin Breit <battery841@mediaone.net> - - * C/apx-common-tasks.sgml: Created its own file. - - * C/usage-mainwindow.sgml: You name it. - - * C/preface.sgml: Pulled shortcuts from here into its own apx - - * C/evolution.sgml: Reordered entities - -2001-06-30 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Pulled organizing stuff, made its own file. - -2001-06-26 Aaron Weber <aaron@ximian.com> - - * C/evolution-faq.sgml: Revised move/rename/copy questions, now - that these functions work. - -2001-06-25 Aaron Weber <aaron@ximian.com> - - * C/evolution-faq.sgml: Now that bug-buddy works with our - bugzilla, update faq to reflect it. - -2001-06-25 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Put config-encryption in usage-mail.sgml. - config-encryption.sgml should be depreciated. - - * C/usage-contact.sgml: Fixed typo - - * C/usage-mail.sgml: Added info about mailing lists Elaborated on - mailing lists - - * C/usage-exec-summary.sgml: Fixed a few typos - - * C/preface.sgml: Added section for importing files - - * C/usage-calendar.sgml: Removed some *'s that are causing - problems. - -2001-06-22 Kevin Breit <battery841@mediaone.net> - - * C/preface.sgml: Put in Contacts information in the quicktasks. - - * C/usage-mail.sgml: Pulled some redundant information. - -2001-06-21 battery841 <battery841@mediaone.net> - - * C/preface.sgml, C/fig/mail-inbox.png, C/fig/mainwindow-pic.png, - C/usage-mail.sgml: Updated screenshots and redid layout for - graphics on pages. - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-contact.sgml: Fixed .gif problem - - * C/usage-mail.sgml: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Specify the file format - - * C/usage-contact.sgml, C/usage-mail.sgml: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Trying to fix the .gif problem - - * C/fig/calendar.png, C/fig/contact.png, C/usage-calendar.sgml: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-calendar.sgml: Redid graphics to add labels to them and - described the labels in text. - - * C/config-encryption.sgml, C/evolution.sgml: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/evolution.sgml: Added config-encryption.sgml for building - - * C/fig/calendar.png, C/fig/config-cal.png, C/fig/config-mail.png, - C/fig/filter-assist-fig.png, C/fig/filter-new-fig.png, - C/fig/mail-composer.png, C/fig/mail-druid-pic.png, - C/fig/mail-inbox.png, C/fig/print-dest.png, - C/fig/print-preview.png, C/fig/vfolder-createrule-fig.png: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/fig/*png: Updated graphics for newer UI. - - * C/fig/full-1.png, C/fig/full-2.png, C/fig/full-3.png, - C/fig/full-4.png, C/fig/full-5.png, C/fig/full-6.png, - C/fig/full-7.png, C/fig/mainwindow-pic.png, C/usage-mail.sgml: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Redid graphics to add labels to them and - described in labels in text. Looks good! - - * C/usage-encryption.sgml: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/encryption.sgml: Added file - - * C/preface.sgml: - -2001-06-20 Kevin Breit <battery841@mediaone.net> - - * doc/ChangeLog: Moved my entires to doc/ChangeLog per request of - danw - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-contact.sgml: Fixed .gif problem - - * C/usage-mail.sgml: Specify the file format - - * C/usage-mail.sgml: Trying to fix the .gif problem - - * C/usage-calendar.sgml: Redid graphics to add labels to them and - described the labels in text. - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/evolution.sgml: Added config-encryption.sgml for building - - * C/fig/*png: Updated graphics for newer UI. - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Redid graphics to add labels to them and - described in labels in text. Looks good! - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: - -2001-06-21 Kevin Breit <battery841@mediaone.net> - - * C/encryption.sgml: Added file - -2001-06-20 Kevin Breit <battery841@mediaone.net> - - * ChangeLog: Moved my entires to doc/ChangeLog per request of danw - -2001-06-20 Kevin Breit <battery841@mediaone.net> - - * C/config-setupassist.sgml: Updated for new UI. - -2001-06-20 Kevin Breit <battery841@mediaone.net> - - * C/usage-sync: Reworded a little bit for more descrip. - -2001-06-20 Kevin Breit <battery841@mediaone.net> - - * C/usage-calendar.sgml: Documented categorizing an event. - -2001-06-20 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Updated Bcc: example - -2001-06-19 Aaron Weber <aaron@ximian.com> - - * C/usage-mainwindow.sgml: A couple changes to Kevin's update. - -2001-06-19 Kevin Breit <battery841@mediaone.net> - - * C/usage-mail.sgml: Basic edits - -2001-06-19 Kevin Breit <battery841@mediaone.net> - - * C/usage-exec-summary: Updated to say "My Evolution" - -2001-06-19 Kevin Breit <battery841@mediaone.net> - - * C/apx-gloss.sgml: Added definition. - - * C/usage-mainwindow.sgml: Routine updates. - -2001-06-07 Duncan Mak <duncan@lumox.simplemente.net> - - * C/evolution-faq.sgml: Fixed a typo. Thanks to Greg Leblanc for - pointing this out. - -2001-05-23 Ettore Perazzoli <ettore@ximian.com> - - * C/evolution-faq.sgml: Re-indented. - -2001-05-18 Duncan Mak <duncan@ximian.com> - - * C/evolution-faq.sgml: Added two questions about importing - Outlook (text from Iain). Fixed some tags and cleaned up a bit - here and there. - -2001-05-18 Ettore Perazzoli <ettore@ximian.com> - - * C/evolution-faq.sgml: Added a question about the permission - issues with /var/spool/mail. - -2001-05-15 Ettore Perazzoli <ettore@ximian.com> - - * C/Makefile.am (SGML_FILES): Renamed to `GUIDE_SGML_FILES'. - (EXTRA_DIST): Add `$(FAQ_SGML_FILES)'. - (all): Depend on `evolution-faq' too. - (evolution-faq): New. - (install-data-local): Depend on `evolution-faq' too. Install the - FAQ into `$(evolution_helpdir)/evolution-faq' and the guide into - `$(evolution_helpdir)/evolution-guide'. - - * C/evolution-faq.sgml: New. - -2001-04-23 Jon Trowbridge <trow@ximian.com> - - * C/Makefile.am (install-data-local): Changed dependency for - install-data-local from "evolution" to "evolution-guide". - -2001-04-23 Ettore Perazzoli <ettore@ximian.com> - - * C/Makefile.am (evolution-guide): Use `$(srcdir)' here. - -2001-04-23 Ettore Perazzoli <ettore@ximian.com> - - * C/Makefile.am (SGML_FILES): Add `evolution.sgml'. - (evolution-guide): Process `evolution.sgml', not - `evolution-guide.sgml'. - (dist-hook): s/evolution-guide/evolution/ - (install-data-local): Likewise. - -2001-02-23 Aaron Weber <aaron@helixcode.com> - - * C/apx-authors.sgml: s/helixcode/ximian (How I missed this page - on the first go-round I don't know). - -2001-03-14 Gediminas Paulauskas <menesis@delfi.lt> - - * C/Makefile.am: there's no apx-fdl.sgml and evolution-guide.sgml - anymore - -2001-02-23 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: IMAP subscriptions stuff. - -2001-02-21 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: Advanced search/show all/save search stuff. - - * C/evolution.sgml: This file replaces evolution-guide.sgml, for - Nautilus Readiness. - - * C/apx-gloss.sgml: glossterm conduit. - - * C/config-sync.sgml: Glossterm conduit. - - * C/preface.sgml: Checked over for Keyboard-Shortcut and other - truthfulness. - -2001-02-15 Aaron Weber <aaron@helixcode.com> - - * C/evolution-guide.sgml: Validated. Verified. Markup fixed in - several individual files. - - * C/apx-gpl.sgml: cvs-removed for GNOME 1.4 compliance. - - * C/apx-fdl.sgml: cvs-removed for GNOME 1.4 compliance. - -2001-02-09 Aaron Weber <aaron@helixcode.com> - - * C/config-sync.sgml: Overhaul. Now accurate and truthful and - clear. - - * C/usage-calendar.sgml: Minor Changes. - -2001-02-08 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Minor Changes. - - * C/usage-mail.sgml: Minor Changes. - -2001-02-07 Aaron Weber <aaron@helixcode.com> - - * C/menuref.sgml: Added section, but left blank til UI stabilizes. - - * C/usage-exec-summary.sgml: A little functionality described. - - * C/usage-mainwindow.sgml: Added tasks and Exec-summary. - - * C/usage-calendar.sgml: Describe semi-autonomy of task pad. - -2001-02-06 Aaron Weber <aaron@ximian.com> - - * C/usage-contact.sgml: s/contact manager/address book/ and - revised text. - - * C/usage-exec-summary.sgml: New file. Describes Executive - Summary. - -2001-01-19 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: More of Megan's revisions, and Field Chooser - functions in the Sort section. - - * C/apx-gloss.sgml: added "ToolTip" - -2001-01-18 Aaron Weber <aaron@helixcode.com> - - * C/preface.sgml: s/Helix Code/Ximian, and Megan's comments. - - * C/usage-mainwindow.sgml: s/Helix Code/Ximian/, and Megan's - comments. - - * C/evolution-guide.sgml: s/Helix Code/Ximian/ - -2000-12-13 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: Revisions as suggested by Dan. Especially to - filter dialogs... which still need some renaming, IMHO. - - * C/usage-mainwindow.sgml: Revisions as suggested by - Dan. Especially to the Folder Limits thing, which still upsets me - somehow. - - * C/preface.sgml: Revisions as suggested by Dan. - -2000-11-29 Aaron Weber <aaron@helixcode.com> - - * C/config-setupassist.sgml: added some <glossterms>, added - linkends to existing glossterms. - -2000-11-28 Aaron Weber <aaron@helixcode.com> - - * C/evolution-guide.sgml: Changed intro to Config section. Now - defines what, exactly, "configurable" means. - - * C/usage-print.sgml: Stylistic revisions. - - * C/usage-calendar.sgml: Stylistic revisions. - - * C/usage-contact.sgml: Stylistic revisions. - -2000-11-09 Aaron Weber <aaron@helixcode.com> - - * C/menuref.sgml: Message heading Right-Click Menu. - -2000-11-03 Aaron Weber <aaron@helixcode.com> - - * C/apx-gloss.sgml: The regexp example was quite wrong. Props to - Sasha. - -2000-11-02 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Style and spelling. - -2000-11-01 Aaron Weber <aaron@helixcode.com> - - * C/config-prefs.sgml: Fixed validation errors. - - * C/apx-gloss.sgml: Fixed HTML, style stuff. - - * C/usage-mail.sgml: Stylistic overhaul. - - * C/usage-mainwindow.sgml: Fixed groups in shortcut bar, fixed - folder navigation tips. - -2000-10-31 Aaron Weber <aaron@helixcode.com> - - * C/preface.sgml: Minor stylistic revisions. - -2000-10-30 Aaron Weber <aaron@helixcode.com> - - * COPYING-DOCS: New file. This is the official place to put the - FDL now. - - -2000-11-01 Radek Doulik <rodo@helixcode.com> - - * Keybindings: added composer keybindings description - -2000-10-25 Aaron Weber <aaron@helixcode.com> - - * C/menuref.sgml: Actions -> New Directory Server added. - - * C/config-prefs.sgml: Actions -> New Directory Server added. - - * C/usage-contact.sgml: Actions -> New Directory Server added. - - * C/menuref.sgml: Added mail Settings->Manage Subscriptions menu. - - * C/usage-mail.sgml: Subscriptions section added. Quite - incomplete, though. - -2000-10-11 Aaron Weber <aaron@helixcode.com> - - * C/evolution-guide.sgml: Re-checked validity of all files. Made - minor changes to menuref.sgml, usage-mail.sgml, usage-print.sgml - to bring up to spec. - - * C/usage-mail.sgml: Redid Filter & Vfolder to match the new & - improved functionality. - - * C/fig/*: Re-did remaining screenshots. - -2000-10-10 Aaron Weber <aaron@helixcode.com> - - * C/usage-print.sgml: New file, describing printing and - print-preview. - - * C/fig/print-preview.png: New file. - - * C/fig/print-dest.png: New file. - - * C/evolution-guide.sgml: Added usage-print entity. - - * C/menuref.sgml: Fixed calendar menu stuff. - - * C/usage-mail.sgml: No more "Actions" menu, other assorted - menu-related changes. - -2000-10-06 Aaron Weber <aaron@helixcode.com> - - * C/fig/ * replaced a whole bunch of screenshots. - -2000-10-05 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Described Search features. - - * C/menuref.sgml: Contact Manager menus fixed. - -2000-10-04 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Fixed glossterms. - - * C/usage-mail.sgml: Fixed glossterms, filenames, spellchecked. - - * C/apx-gloss.sgml: Added "Inline," "VCard". - - * C/usage-mainwindow.sgml: Fixed glossterms, - filenames. Spellchecked. - - * C/usage-mail.sgml: Fixed glossterms, filenames. Spellchecked. - - * C/evolution-guide.sgml: New Legalnotice. Removed FDL and GPL, - which are now included as part of the gnome-help package. - - * C/usage-contact.sgml: Spellcheck. Fixed some wording, and - responded to clahey's suggestions-- notably, commented out the - "add to master list" category feature. - - * C/usage-calendar.sgml: Spellcheck. Fixed wording, event overlap - description. - - * C/evolution-guide.sgml: Spellcheck. Commented out Notes - entities. - - * C/usage-notes.sgml: Spellchecked, then decided to comment out - this file/chapter and all references to it, since it's unlikely to - be implemented any time soon. - - * C/config-setupassist.sgml: Spellcheck. Other minor updates. May - need more work in the near future. - - * C/usage-sync.sgml: Now it's really short. And spelled correctly. - -2000-10-03 Aaron Weber <aaron@helixcode.com> - - * C/config-prefs.sgml: Mostly spelling. Still needs major - alteration. - - * C/menuref.sgml: s/Appintment/Appointment, fixed small errors, - ran spellcheck. Still needs lots of work, since many menus have - changed. - - * C/apx-gloss.sgml: Added Virus, Protocol, fixed vFolder, - spellchecked. - -2000-09-26 Aaron Weber <aaron@helixcode.com> - - * C/apx-gloss.sgml: Added sendmail and SMTP. - -2000-09-22 Aaron Weber <aaron@helixcode.com> - - * C/menuref.sgml: Changed to reflect new menu layout. - - * C/usage-mainwindow.sgml: Changed to reflect new menu - layout. Again. - - * C/usage-contact.sgml: Stop and Display All features. - -2000-09-21 Aaron Weber <aaron@helixcode.com> - - * C/evolution-guide.sgml: Switched to the "official" FSF markup. - I will have to make changes to the markup-- adding ids, etc, or - switch to another version of the markup. Pending discussion by - GDP. - - * C/apx-authors.sgml: Changed Matt Loper's email address to - loper.org; added Jeff Stedfast and Peter Williams to authors list, - realphebetized. - - * C/config-prefs.sgml: Revision to reflect current options - labelling. - - * C/evolution-guide.sgml: Changes to part intros. - - * C/preface.sgml: Spelling and menu fixes. Will need more work - tomorrow. - -2000-09-20 Aaron Weber <aaron@helixcode.com> - - * C/config-prefs.sgml: Fixed sig stuff here and in setupassist. - - * C/config-sync.sgml: Fixed description of conduit usage. - -2000-09-18 Aaron Weber <aaron@helixcode.com> - - * C/preface.sgml: Spelling fixes, etc. - -2000-09-19 Federico Mena Quintero <federico@helixcode.com> - - * C/Makefile.am: Fixed to install the stylesheet-images as well. - -2000-09-07 Aaron Weber <aaron@helixcode.com> - - * C/fig/ New files: contact-editor.png, mail-composer.png, - filter-assist-fig.png, mail-inbox.png - -2000-09-07 Aaron Weber <aaron@helixcode.com> - - * C/preface.sgml: Redid "soft" intro stuff. - - * C/evolution-guide.sgml: Accidentally broke docs, now valid. - -2000-09-06 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Editing, proofing. - -2000-09-05 Aaron Weber <aaron@helixcode.com> - - * C/usage-contact.sgml: Grammar, links, screenshots. - - * fig/* Re-took most screenshots. - - * C/usage-mail.sgml: Filters, proofing. - -2000-09-01 Aaron Weber <aaron@helixcode.com> - - * C/config-prefs.sgml: Added coverage of news, clarified POP/IMAP - distinction (there's a theme to these four log entries here). - - * C/usage-mail.sgml: Added coverage of news. - - * C/config-setupassist.sgml: Revised mail sources content for - IMAP/POP stuff. - - * C/apx-gloss.sgml: Added IMAP and POP. - -2000-08-31 Aaron Weber <aaron@helixcode.com> - - * C/apx-gloss.sgml: Added regular expressions to glossary. - Explanation should be removed from other portions of the book now. - - * C/usage-mainwindow.sgml: Revisions, minor. - - * C/apx-menuref.sgml: Now named menuref.sgml, to reflect its new - status as a part. - - * C/evolution-guide.sgml: Structural alterations: Menuref is now a - part, not an appendix. - - * C/apx-menuref.sgml: Added contextual menus for mail. - - * C/preface.sgml: Added "quickref and pointers" sections. Props to - O'Reilly for the copy of Outlook in a Nutshell which gave me the - idea. - -2000-08-30 Aaron Weber <aaron@helixcode.com> - - * C/usage-mainwindow.sgml: Minor fixes. - - * C/preface.sgml: Corrected grammar, added glossterms, described - menuref. - -2000-08-25 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: Redid filter and vFolder assistant - descriptions. - - * C/fig/filter-new-fig.png: Replaced with new assistant pic. - - * C/fig/filter-assist-fig.png: New file, showing only assistant. - - - * C/apx-menuref.sgml: Finished message composer and calendar - editor menus. Looked at Contact Editor menus and decided to - document those features after implementation. - -2000-08-24 Aaron Weber <aaron@helixcode.com> - - * C/apx-menuref.sgml: Message Composer File and Edit menus. - -2000-08-23 Aaron Weber <aaron@helixcode.com> - - * C/apx-menuref.sgml: Added editor sections. - - * C/evolution-guide.sgml: Included Menu Reference Appendix. - -2000-08-22 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: Minor markup changes. - - * C/apx-menuref.sgml: New File. Menu Reference. Still needs much - work, but not bad for an evening. - -2000-08-21 Aaron Weber <aaron@helixcode.com> - - * C/usage-mail.sgml: Kevin's diff applied, with minor changes. - -2000-08-09 Aaron Weber <aaron@helixcode.com> - - * C/evolution-guide.sgml: Fixed bugs in validation. Went home to - sleep. - - * 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. - - -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. - -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. - -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. - -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/Keybindings b/doc/Keybindings deleted file mode 100644 index f232802110..0000000000 --- a/doc/Keybindings +++ /dev/null @@ -1,13 +0,0 @@ -* Keybindings for the mailer - - Delete key: Deletes message, moves forward. - -* Keybindings for the composer - - Control-s: Saves message to file. - Control-w: Closes composer window. - Control-Return: Sends message now. - - F6: Opens find dialog. - F7: Opens replace dialog. - diff --git a/doc/Makefile.am b/doc/Makefile.am deleted file mode 100644 index 75be1c7ed2..0000000000 --- a/doc/Makefile.am +++ /dev/null @@ -1 +0,0 @@ -SUBDIRS = devel diff --git a/doc/NAMESPACE b/doc/NAMESPACE deleted file mode 100644 index 4ca7c454d1..0000000000 --- a/doc/NAMESPACE +++ /dev/null @@ -1,65 +0,0 @@ - - Here is how both the Evolution implementation and IDL namespacing -is to be organized, NB. for implementations and oafinfo filenames we replace -'/' with '_' - -Files: - -/GNOME/Evolution/ - - Addressbook/ - Calendar/ - Control - gnomecal - Composer/ - Mail/ - Notes/ - Shell/ - Summary/ - test - rdf - Wombat/ - -Components: - - Shell components end in _ShellComponent, controls in _Control, -executive summary components in _ExecutiveSummaryComponent and -factories append 'Factory'. - -GNOME/ - Evolution/ - - Shell - - Addressbook/ - MiniCard/ - Control, ControlFactory - SelectNames, SelectNamesFactory - Control, ControlFactory - ShellComponent, ShellComponentFactory - Calendar/ - iTip/ - Control, ControlFactory - Control, ControlFactory - ShellComponent, ShellComponentFactory - ExecutiveSummaryComponent, ExecutiveSummaryComponentFactory - Mail/ - Control, ControlFactory - ShellComponent, ShellComponentFactory - ExecutiveSummaryComponent, ExecutiveSummaryComponentFactory - Composer, ComposerFactory - Notes/ - control, controlFactory - shellComponent, shellComponentFactory - Summary/ - rdf/ - SummaryComponent, SummaryComponentFactory - test/ - Component, ComponentFactory - - ShellComponent, ShellComponentFactory - - Wombat/ - ServerFactory - CalendarFactory - diff --git a/doc/devel/.cvsignore b/doc/devel/.cvsignore deleted file mode 100644 index 81268d18cf..0000000000 --- a/doc/devel/.cvsignore +++ /dev/null @@ -1,5 +0,0 @@ -Makefile -Makefile.in -html -evolution-devel-guide.html -*.stamp diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog deleted file mode 100644 index 673dbd1156..0000000000 --- a/doc/devel/ChangeLog +++ /dev/null @@ -1,256 +0,0 @@ -2001-10-29 Federico Mena Quintero <federico@ximian.com> - - * calendar/alarm-generation.sgml: Updated docs for repeating - alarms. - -2001-07-31 Ettore Perazzoli <ettore@ximian.com> - - * Makefile.am (dist-hook): Remove the copying of the - index.sgml file which doesn't seem to be generated - anywhere anyway. - -2001-06-25 Peter Williams <peterw@ximian.com> - - * Makefile.am: ... and comment out more exec summary stuff. - - * reference.sgml: Here too. - -2001-06-25 Peter Williams <peterw@ximian.com> - - * calendar/cal-util/Makefile.am, - calendar/cal-client/Makefile.am: Fix make dist. - - * Makefile.am: clean up a bit. - -2001-06-21 JP Rosevear <jpr@ximian.com> - - * Makefile.am: disable executive summary build because it is no - longer built - -2001-06-21 JP Rosevear <jpr@ximian.com> - - * calendar/cal-client/Makefile.am: add new lib - -2001-06-21 Peter Williams <peterw@ximian.com> - - * Makefile.am: - calendar/cal-client/Makefile.am: - calendar/cal-util/Makefile.am: - importer/Makefile.am: - executive-summary/Makefile.am: Changed to used gtk-doc's - canonical Makefile.am (plus some tweaks because not every - dir builds html). - -2001-06-14 Damon Chaplin <damon@ximian.com> - - * executive-summary/.cvsignore: - * calendar/cal-util/.cvsignore: - * calendar/cal-client/.cvsignore: added *-undocumented.txt - -2001-05-24 Federico Mena Quintero <federico@ximian.com> - - * evolution-devel-guide.sgml: s/Helix Code/Ximian - -2001-05-15 Jeffrey Stedfast <fejj@ximian.com> - - * Removed some evolution-*-decl.txt files since these are - autogenerated by gtk-doc and don't belong in cvs anyway. - Should the tmpl/ dirs also be removed?? - - Updated: Readded them and updated the .cvsignore files - I guess - we do need them after all ;-) - -2001-04-25 Jon Trowbridge <trow@ximian.com> - - * Removed generated files from CVS, updated .cvsignore files - to include generated files. - -2001-04-23 Ettore Perazzoli <ettore@ximian.com> - - * executive-summary/Makefile.am (scan) [ENABLE_GTK_DOC]: Kludge - builddir != srcdir behavior by symlinking the $(DOC_MODULE).types - file into the builddir. - * calendar/cal-client/Makefile.am (scan) [ENABLE_GTK_DOC]: - Likewise. - * calendar/cal-util/Makefile.am (scan) [ENABLE_GTK_DOC]: Likewise. - -2001-04-23 Ettore Perazzoli <ettore@ximian.com> - - * evolution-devel-guide.sgml: Disable the importer references here - too. - - * Makefile.am: Remove the importer stuff for now. - -2001-04-20 Damon Chaplin <damon@ximian.com> - - * importer/evolution-shell-importer.types: changed path to the - importer header files, since we've had reports that they aren't being - found (though it worked OK for me). - -2001-04-17 Ettore Perazzoli <ettore@ximian.com> - - * calendar/cal-client/Makefile.am (install-data-local): Install - the $(DOC_DIR_INSTALL_FILES) from the srcdir. - * calendar/cal-util/Makefile.am (install-data-local): Likewise. - * importer/Makefile.am (install-data-local): Likewise. - * executive-summary/Makefile.am (install-data-local): Likewise. - -2001-01-26 John R. Sheets <dusk@ravendusk.org> - - * importer/Makefile.am: Change (nonexistant) importer.sgml - references to evolution-importer.sgml to fix dependency problem. - -2001-01-17 Iain Holmes <iain@ximian.com> - - * Makefile.am (local_entities): Added the importer stuff. - - * evolution-devel-guide.sgml: Added entities for the importer documents. - - * reference.sgml: Added the public and private APIs for the importer. - - * importer/*: New directory containing all the documenation for the - importer. - -2001-01-17 Federico Mena Quintero <federico@ximian.com> - - * evolution-devel-guide.sgml: Ximianified. - - * calendar/evolution-calendar.sgml: Ditto. - - * calendar/cal-util/evolution-cal-util-sections.txt: Updated. - - * calendar/cal-client/evolution-cal-client-sections.txt: Updated. - -2001-01-10 Federico Mena Quintero <federico@helixcode.com> - - * Makefile.am: Make it work when gtk-doc is not installed. - - * calendar/cal-client/Makefile.am: Likewise. - - * calendar/cal-util/Makefile.am: Likewise. - -2000-12-19 Federico Mena Quintero <federico@helixcode.com> - - Added proper dependency lists to the gtk-doc mess. - - * calendar/cal-client/Makefile.am (TARGET_DIR): Removed unused - variable. - (SOURCE_FILES): New variable with the list of source files we - depend on. - (IGNORED_SOURCE_HEADERS): New variable with the headers we ignore - for the gtkdoc-scan phase. - (scan_generated): - (tmpl_dependencies): - (tmpl_sources): - (tmpl_generated); - (sgml_dependencies): - (sgml_generated): Lists of stuff that is generated and that other - stuff depends on. - (all): Added the $(sgml_generated) as the final target. - (install-data-local): Added an installation hook; gtk-doc seems to - want some of its generated files to be installed. - - * calendar/cal-client/evolution-cal-client-sections.txt: Updated. - - * calendar/cal-util/Makefile.am: Made the same changes as for - calendar/cal-client/Makefile.am. - - * calendar/cal-util/evolution-cal-util-sections.txt: Updated. - - * Makefile.am (local_entities): Added alarm-generation.sgml. - (all): Made the main target be the html/index.html. - -2000-12-18 Federico Mena Quintero <federico@helixcode.com> - - * calendar/alarm-generation.sgml: New file with a description of - the algorithm used to generate alarm instances. - - * evolution-devel-guide.sgml: Added an entity for the above - chapter. - - * calendar/evolution-calendar.sgml: Reference the entity here. - - * calendar/Makefile.am (EXTRA_DIST): Added alarm-generation.sgml. - -2000-12-13 Larry Ewing <lewing@helixcode.com> - - * calendar/Makefile.am (EXTRA_DIST): make it public-reference.sgml - not referenc.sgml here. - -2000-11-29 Federico Mena Quintero <federico@helixcode.com> - - * calendar/architecture.sgml: Finished the calendar architecture - chapter. - -2000-11-29 Federico Mena Quintero <federico@helixcode.com> - - * evolution-devel-guide.sgml: Added an id for the API reference <part>. - Added the FDL <legalnotice>. - Added the preface and toplevel reference entities. - Added entities for Evolution, Wombat, and Camel. - Added an appendix for the GNU FDL. - - * preface.sgml: New file with the introduction to the Evolution - Developer's Guide. - - * reference.sgml: Split the toplevel reference part into its own - file. - - * fdl.sgml: Added the GNU Free Documentation License. - - * calendar/evolution-calendar.sgml: Added an id for the <part>. - - * calendar/public-reference.sgml: Added an id for the <reference>. - Moved this file over from calendar/reference.sgml. - - * Makefile.am (local_entities): Added a list of the SGML files - that define entities for inclusion in the toplevel document. This - way we can track documentation file dependencies down to all - levels. - (html/index.html): Made the toplevel document depend on - $(local_entities). Also, removed the "html" target and put its - contents directly here; this way we avoid having .PHONY targets. - (EXTRA_DIST): Removed the evolution_devel_guideDATA; it made no - sense. - (content_files): Added preface.sgml and reference.sgml. - -2000-09-15 Federico Mena Quintero <federico@helixcode.com> - - * evolution-devel-guide.sgml: Made the toplevel <book> id be - "index". - -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 f8597eccf1..0000000000 --- a/doc/devel/Makefile.am +++ /dev/null @@ -1,178 +0,0 @@ -## Process this file with automake to produce Makefile.in - -SUBDIRS = calendar - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-devel-guide - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=evolution-devel-guide.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -#DOC_SOURCE_DIR= - -# Extra options to supply to gtkdoc-scan. -#SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -#MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -#FIXXREF_OPTIONS= - -# Used for dependencies. -#HFILE_GLOB= -#CFILE_GLOB= - -# Header files to ignore when scanning. -#IGNORE_HFILES= - -# Images to copy into HTML directory. -HTML_IMAGES = - - -# Add your module's hand-written and auto-generated files here; these -# are used for dependency tracking. - -local_entities = \ - calendar/alarm-generation.sgml \ - calendar/architecture.sgml \ - calendar/evolution-calendar.sgml \ - calendar/public-reference.sgml \ - \ - calendar/cal-client/sgml/cal-client.sgml \ - \ - calendar/cal-util/sgml/cal-component.sgml \ - calendar/cal-util/sgml/cal-recur.sgml \ - calendar/cal-util/sgml/cal-util.sgml \ - calendar/cal-util/sgml/timeutil.sgml - -# executive-summary/sgml/executive-summary-component.sgml \ -# executive-summary/sgml/executive-summary-component-factory.sgml \ -# executive-summary/sgml/executive-summary-component-factory-client.sgml \ -# executive-summary/sgml/executive-summary-html-view.sgml - -# importer/sgml/evolution-importer.sgml \ -# importer/sgml/evolution-importer-client.sgml - -installed_content_files = \ - fdl.sgml \ - preface.sgml \ - reference.sgml - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = \ - $(installed_content_files) \ - $(local_entities) - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -#GTKDOC_CFLAGS = -#GTKDOC_LIBS = -# -#GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -#GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt - -HTML_DIR = $(datadir)/gnome/html - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(extra_files) \ - $(installed_content_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) - -# $(DOC_MODULE).types \ -# $(DOC_MODULE)-sections.txt \ -# $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -#SCANOBJ_FILES = \ -# $(DOC_MODULE).args \ -# $(DOC_MODULE).hierarchy \ -# $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -all-local: html-build.stamp - -#### html #### - -html-build.stamp: $(DOC_MAIN_SGML_FILE) $(content_files) #sgml.stamp - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak *-unused.txt $(DOC_STAMPS) # $(SCANOBJ_FILES) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -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; \ - fi) - -# echo '-- Installing $(srcdir)/html/index.sgml' ; \ -# $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/html - files=`echo $(srcdir)/html/*.html` ; \ - test '$(srcdir)/html/*.html' = "$$files" \ - || cp $$files $(distdir)/html - files=`echo $(srcdir)/html/*.css` ; \ - test '$(srcdir)/html/*.css' = "$$files" \ - || cp $$files $(distdir)/html - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -# mkdir $(distdir)/tmpl -# mkdir $(distdir)/sgml -# -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml -# -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -.PHONY : dist-hook-local 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 028622bd82..0000000000 --- a/doc/devel/calendar/Makefile.am +++ /dev/null @@ -1,7 +0,0 @@ -SUBDIRS = cal-util cal-client - -EXTRA_DIST = \ - alarm-generation.sgml \ - architecture.sgml \ - evolution-calendar.sgml \ - public-reference.sgml diff --git a/doc/devel/calendar/alarm-generation.sgml b/doc/devel/calendar/alarm-generation.sgml deleted file mode 100644 index 46f7e4bff1..0000000000 --- a/doc/devel/calendar/alarm-generation.sgml +++ /dev/null @@ -1,155 +0,0 @@ - <chapter id="calendar-alarm-generation"> - <title>How the Wombat generates alarm instances</title> - - <para> - This chapter describes the algorithm that the &Wombat; uses - internally to generate instances of a calendar component's - alarms. You do not need to read this chapter if you are simply - using the client-side functions. - </para> - - <sect1 id="what-makes-up-an-alarm-trigger"> - <title>What makes up an alarm trigger</title> - - <para> - VTODO and VEVENT calendar components can have any number of - alarms defined for them. Each alarm has a trigger - specification, an alarm type (display, audio, email, or - procedure), and data corresponding to the alarm type. The - Wombat side of things is interested only in the trigger - specification, since this is all that the Wombat needs to - produce alarm instances. - </para> - - <para> - An alarm trigger can be relative or absolute. Relative - triggers occur a certain time before or after the start or end - of a calendar component's occurrence. For example, you could - configure a trigger to notify you 15 minutes before an - appointment starts, so that you can get to its location on - time; or another one to notify you 5 minutes after another - person's meeting has ended, so that you can call that person - on the phone after the meeting and not disturb him while - there. Absolute triggers occur at a specific point in time; - you can configure an alarm to trigger exactly at a particular - date and time that has no relation to the component's - occurrences at all. - </para> - </sect1> - - <sect1 id="generating-trigger-instances"> - <title>Generating trigger instances</title> - - <para> - Generating absolute triggers is trivial; you just use the date - and time they specify. However, relative triggers are - associated to recurrence instances, so in order to generate - trigger instances we must generate the corresponding - recurrence instances and compute the trigger times based on - those. - </para> - - <para> - Since relative triggers are specified as occurring a certain - amount of time before or after each of a calendar component's - recurrence instances, we can compute a trigger time by adding - or subtracting that amount of time to the corresponding - recurrence instance's time. - </para> - - <para> - Recurrence instances are generated by specifying a range of - time and asking the Wombat to generate the instances that - occur within that range. We shall see that the range of time - in which instances occur is not necessarily the same range of - time in which those instances' alarm triggers occur. - </para> - - <para> - Consider an alarm that is set to trigger 10 minutes before the - start time of an event's occurrence, that is, the trigger has - an offset of -10 minutes. Say this event recurs every hour at - 5 minutes past the hour: it would occur at 1:05, 2:05, 3:05, - etc.; the corresponding triggers would occur at 12:55, 1:55, - 2:55, etc. If we wish to compute the alarm triggers that - occur between 4:00 and 6:00 (which would be at 4:55 and 5:55), - then we cannot just generate recurrence instances between 4:00 - and 6:00 because we will miss the 6:05 occurrence which - corresponds to the 5:55 trigger. - </para> - - <para> - The solution is to expand the range of time on both sides to - fit the relative triggers that have the largest time periods. - If a trigger's offset is negative, like the -10 minutes in the - example above, then we must expand the - <emphasis>end</emphasis> of the time range: in the case above, - the range's ending time of 6:00 must be grown by 10 minutes to - 6:10 so that the last recurrence instance will be that of - 6:05; computing the trigger's offset we will get the 5:55 - trigger, which is what we wanted. For triggers with positive - offsets, like if an alarm were to trigger 20 minutes after an - event's occurrence, we must expand the - <emphasis>start</emphasis> of the time range in an analogous - way, by subtracting the time offset from it. - </para> - - <para> - Again, absolute triggers need no special computation. We can - just see if the trigger time is within the requested range of - time, and if so, we take that trigger occurrence into account - for the final result. - </para> - - <para> - In addition, alarms may specify a number of repetitions and a - duration time. For example, an alarm may be configured to - repeat 3 extra times after the original occurrence with 5 - minutes between each repetition. Again, for absolute triggers - this does not present a problem, as we can just generate the - repetitions starting from the absolute trigger time. For - relative triggers, we expand the range as described above and - also add the total offset for the repetitions to the start of - the range, i.e. 15 extra minutes for the case of 3 repetitions - with 5 minutes between each. We do not need to modify the end - of the range because alarm repetitions always have positive - offsets, so they are equivalent to relative alarm triggers - with positive offsets. - </para> - </sect1> - - <sect1 id="alarm-trigger-generation-code"> - <title>Alarm trigger generation code</title> - - <para> - The main function to generate alarm trigger instances is - <function>generate_alarms_for_comp()</function> in - <filename>evolution/calendar/pcs/cal-backend-file.c</filename>. - This function calls <function>compute_alarm_range()</function> - to expand the specified range of time in the way described in - the previous section. It then generates the instances for - relative alarm triggers inside the - <function>add_alarm_occurrences_cb()</function> callback, - which is used by - <function>cal_recur_generate_instances()</function> with the - expanded range of time. The callback goes through all of the - calendar component's relative alarm triggers and adds the - trigger offsets to the occurrence's time; the results are - added as <structname>CalAlarmInstance</structname> structures - to the final list of trigger instances. Finally, - <function>generate_alarms_for_comp()</function> calls - <function>generate_absolute_triggers()</function>, which - simply adds the instances for absolute alarm triggers; these - are the absolute times that are within the time range that was - requested originally. In the very end, the list of instances - is sorted to produce nicer results. - </para> - </sect1> - </chapter> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/calendar/architecture.sgml b/doc/devel/calendar/architecture.sgml deleted file mode 100644 index d261f0a7f4..0000000000 --- a/doc/devel/calendar/architecture.sgml +++ /dev/null @@ -1,162 +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> - Looking for the events that recur or have alarm triggers in - a specific period of time involves scanning all the - appointments in a calendar. To keep clients from having to - load whole calendars at once, the &PCS; can do these - computations and send the results to clients. - </para> - </formalpara> - - <formalpara> - <title>Modification Log</title> - - <para> - To allow multiple handheld devices to be synchronized - against a calendar, the &PCS; keeps a log of all the - modifications that are done to the calendar. When an - appointment is updated or removed, the &PCS; logs this - action in the modification log. Synchronization conduit - programs can then use this information to do their work. - </para> - </formalpara> - </sect1> - - <!-- Data Views --> - - <sect1> - <title>Data Views</title> - - <para> - &Evolution; provides a graphical calendar client inside the - shell that is just a view onto the data stored in the personal - calendar server. You can launch as many views of a calendar - as you like and they will all receive notification from the - &PCS; when changes occur. The views are then responsible for - updating their respective displays. - </para> - - <para> - Even within a single calendar view in the &Evolution; shell - there can be multiple clients of a single calendar. For - example, in the day view of the &Evolution; calendar there are - three widgets that act as three different clients of the - &PCS;: the multi-day view, the busy days calendar, and the - task list. - </para> - </sect1> - - <!-- Non-graphical Clients --> - - <sect1> - <title>Non-graphical Clients</title> - - <para> - Clients of the personal calendar server can be non-graphical, - that is, they do not have to provide views of the data to the - user. Examples of such clients are the synchronization - conduit programs for handheld devices. These usually run with - no user interface as a result of being invoked by a daemon - that watches the connection to a handheld device. For - example, the calendar synchronization conduit in &Evolution; - gets run when the <application>gpilotd</application> daemon - from the <application>gnome-pilot</application> package - detects that the HotSync button has been pressed on a Palm - Pilot device. - </para> - - <para> - Such clients simply take advantage of the centralized storage - in the &PCS; without presenting any graphical display of the - data; they just act as middlemen between the &PCS; and other - applications. - </para> - </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 87bb93d0b1..0000000000 --- a/doc/devel/calendar/cal-client/.cvsignore +++ /dev/null @@ -1,12 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*-undocumented.txt -*.hierarchy -*.signals -*.stamp -*-scan.c -.libs diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am deleted file mode 100644 index 7452ba35b5..0000000000 --- a/doc/devel/calendar/cal-client/Makefile.am +++ /dev/null @@ -1,195 +0,0 @@ -# The name of the module. -DOC_MODULE=evolution-cal-client - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - -# Used for dependencies. -HFILE_GLOB= \ - $(top_srcdir)/calendar/cal-client/cal-client.c \ - $(top_srcdir)/calendar/cal-client/cal-client-types.c - -CFILE_GLOB= \ - $(top_srcdir)/calendar/cal-client/cal-client.h \ - $(top_srcdir)/calendar/cal-client/cal-client-types.h - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - cal-listener.h \ - evolution-calendar.h - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS= \ - -I$(top_srcdir)/calendar \ - -I$(top_builddir)/calendar/cal-client \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - -I$(top_builddir)/libical/src/libical \ - -I$(top_srcdir)/libical/src/libical \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS= \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-client/.libs/libcal-client-static.al\ - $(top_builddir)/calendar/cal-util/.libs/libcal-util-static.al \ - $(top_builddir)/libical/src/libical/.libs/libical-static.al \ - $(top_builddir)/libversit/.libs/libversit.al \ - $(top_builddir)/libwombat/libwombat.la - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - -#DOC_DIR=$(datadir)/gnome/html - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -#all-local: html-build.stamp -all-local: sgml-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -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); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - files=`echo $(srcdir)/tmpl/*.sgml` ; \ - test '$(srcdir)/tmpl/*.sgml' = "$$files" \ - || cp $$files $(distdir)/tmpl - files=`echo $(srcdir)/sgml/*.sgml` ; \ - test '$(srcdir)/sgml/*.sgml' = "$$files" \ - || cp $$files $(distdir)/sgml - -.PHONY : dist-hook-local 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 bf42dee8d2..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ /dev/null @@ -1,480 +0,0 @@ -<MACRO> -<NAME>CAL_CLIENT_MULTI_TYPE</NAME> -#define CAL_CLIENT_MULTI_TYPE (cal_client_multi_get_type ()) -</MACRO> -<MACRO> -<NAME>CAL_CLIENT_MULTI</NAME> -#define CAL_CLIENT_MULTI(obj) (GTK_CHECK_CAST ((obj), CAL_CLIENT_MULTI_TYPE, CalClientMulti)) -</MACRO> -<MACRO> -<NAME>CAL_CLIENT_MULTI_CLASS</NAME> -#define CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_CLIENT_MULTI_TYPE, CalClientMultiClass)) -</MACRO> -<MACRO> -<NAME>IS_CAL_CLIENT_MULTI</NAME> -#define IS_CAL_CLIENT_MULTI(obj) (GTK_CHECK_TYPE ((obj), CAL_CLIENT_MULTI_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_CAL_CLIENT_MULTI_CLASS</NAME> -#define IS_CAL_CLIENT_MULTI_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_CLIENT_MULTI_TYPE)) -</MACRO> -<STRUCT> -<NAME>CalClientMulti</NAME> -</STRUCT> -<STRUCT> -<NAME>CalClientMultiClass</NAME> -</STRUCT> -<STRUCT> -<NAME>CalClientMultiPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>CalClientMulti</NAME> -struct CalClientMulti { - GtkObject object; - - /* Private data */ - CalClientMultiPrivate *priv; -}; -</STRUCT> -<FUNCTION> -<NAME>cal_client_multi_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_new</NAME> -<RETURNS>CalClientMulti *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_add_client</NAME> -<RETURNS>void </RETURNS> -CalClientMulti *multi, CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_set_auth_func</NAME> -<RETURNS>void </RETURNS> -CalClientMulti *multi,CalClientAuthFunc func,gpointer user_data -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_open_calendar</NAME> -<RETURNS>CalClient *</RETURNS> -CalClientMulti *multi,const char *str_uri,gboolean only_if_exists -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_client_for_uri</NAME> -<RETURNS>CalClient *</RETURNS> -CalClientMulti *multi,const char *uri -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_n_objects</NAME> -<RETURNS>int </RETURNS> -CalClientMulti *multi, CalObjType type -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_object</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClientMulti *multi,const char *uid,CalComponent **comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_timezone</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClientMulti *multi,const char *tzid,icaltimezone **zone -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_uids</NAME> -<RETURNS>GList *</RETURNS> -CalClientMulti *multi, CalObjType type -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_changes</NAME> -<RETURNS>GList *</RETURNS> -CalClientMulti *multi,CalObjType type,const char *change_id -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_objects_in_range</NAME> -<RETURNS>GList *</RETURNS> -CalClientMulti *multi,CalObjType type,time_t start,time_t end -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_free_busy</NAME> -<RETURNS>GList *</RETURNS> -CalClientMulti *multi,GList *users,time_t start,time_t end -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_generate_instances</NAME> -<RETURNS>void </RETURNS> -CalClientMulti *multi,CalObjType type,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data -</FUNCTION> -<FUNCTION> -<NAME>cal_client_multi_get_alarms_in_range</NAME> -<RETURNS>GSList *</RETURNS> -CalClientMulti *multi,time_t start, time_t end -</FUNCTION> -<ENUM> -<NAME>CalClientChangeType</NAME> -typedef enum { - CAL_CLIENT_CHANGE_ADDED = 1 << 0, - CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, - CAL_CLIENT_CHANGE_DELETED = 1 << 2 -} CalClientChangeType; -</ENUM> -<FUNCTION> -<NAME>cal_client_change_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> -<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> -<STRUCT> -<NAME>CalClientPrivate</NAME> -</STRUCT> -<ENUM> -<NAME>CalClientOpenStatus</NAME> -typedef enum { - CAL_CLIENT_OPEN_SUCCESS, - CAL_CLIENT_OPEN_ERROR, - CAL_CLIENT_OPEN_NOT_FOUND, - CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED -} CalClientOpenStatus; -</ENUM> -<ENUM> -<NAME>CalClientSetModeStatus</NAME> -typedef enum { - CAL_CLIENT_SET_MODE_SUCCESS, - CAL_CLIENT_SET_MODE_ERROR, - CAL_CLIENT_SET_MODE_NOT_SUPPORTED -} CalClientSetModeStatus; -</ENUM> -<ENUM> -<NAME>CalClientGetStatus</NAME> -typedef enum { - CAL_CLIENT_GET_SUCCESS, - CAL_CLIENT_GET_NOT_FOUND, - CAL_CLIENT_GET_SYNTAX_ERROR -} CalClientGetStatus; -</ENUM> -<ENUM> -<NAME>CalClientLoadState</NAME> -typedef enum { - CAL_CLIENT_LOAD_NOT_LOADED, - CAL_CLIENT_LOAD_LOADING, - CAL_CLIENT_LOAD_LOADED -} CalClientLoadState; -</ENUM> -<STRUCT> -<NAME>CalClient</NAME> -struct CalClient { - GtkObject object; - - /* Private data */ - CalClientPrivate *priv; -}; -</STRUCT> -<USER_FUNCTION> -<NAME>CalClientAuthFunc</NAME> -<RETURNS>gchar *</RETURNS> -CalClient *client, - const gchar *prompt, - const gchar *key, - gpointer user_data -</USER_FUNCTION> -<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_set_auth_func</NAME> -<RETURNS>void </RETURNS> -CalClient *client, CalClientAuthFunc func, gpointer data -</FUNCTION> -<FUNCTION> -<NAME>cal_client_set_default_timezone</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>cal_client_open_calendar</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *str_uri, gboolean only_if_exists -</FUNCTION> -<FUNCTION> -<NAME>cal_client_uri_list</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalMode mode -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_load_state</NAME> -<RETURNS>CalClientLoadState </RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uri</NAME> -<RETURNS>const char *</RETURNS> -CalClient *client -</FUNCTION> -<FUNCTION> -<NAME>cal_client_set_mode</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, CalMode mode -</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_timezone</NAME> -<RETURNS>CalClientGetStatus </RETURNS> -CalClient *client,const char *tzid,icaltimezone **zone -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_uids</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_changes</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, CalObjType type, const char *change_id -</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_get_free_busy</NAME> -<RETURNS>GList *</RETURNS> -CalClient *client, GList *users,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>GSList *</RETURNS> -CalClient *client, time_t start, time_t end -</FUNCTION> -<FUNCTION> -<NAME>cal_client_free_alarms</NAME> -<RETURNS>void </RETURNS> -GSList *comp_alarms -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_alarms_for_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *uid,time_t start, time_t end,CalComponentAlarms **alarms -</FUNCTION> -<FUNCTION> -<NAME>cal_client_update_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_update_objects</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, icalcomponent *icalcomp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_remove_object</NAME> -<RETURNS>gboolean </RETURNS> -CalClient *client, const char *uid -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_query</NAME> -<RETURNS>CalQuery *</RETURNS> -CalClient *client, const char *sexp -</FUNCTION> -<FUNCTION> -<NAME>cal_client_resolve_tzid_cb</NAME> -<RETURNS>icaltimezone *</RETURNS> -const char *tzid, gpointer data -</FUNCTION> -<FUNCTION> -<NAME>cal_client_get_component_as_string</NAME> -<RETURNS>char *</RETURNS> -CalClient *client,CalComponent *comp -</FUNCTION> -<MACRO> -<NAME>CAL_QUERY_TYPE</NAME> -#define CAL_QUERY_TYPE (cal_query_get_type ()) -</MACRO> -<MACRO> -<NAME>CAL_QUERY</NAME> -#define CAL_QUERY(obj) (GTK_CHECK_CAST ((obj), CAL_QUERY_TYPE, CalQuery)) -</MACRO> -<MACRO> -<NAME>CAL_QUERY_CLASS</NAME> -#define CAL_QUERY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), CAL_QUERY_TYPE, CalQueryClass)) -</MACRO> -<MACRO> -<NAME>IS_CAL_QUERY</NAME> -#define IS_CAL_QUERY(obj) (GTK_CHECK_TYPE ((obj), CAL_QUERY_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_CAL_QUERY_CLASS</NAME> -#define IS_CAL_QUERY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_QUERY_TYPE)) -</MACRO> -<ENUM> -<NAME>CalQueryDoneStatus</NAME> -typedef enum { - CAL_QUERY_DONE_SUCCESS, - CAL_QUERY_DONE_PARSE_ERROR -} CalQueryDoneStatus; -</ENUM> -<STRUCT> -<NAME>CalQueryPrivate</NAME> -</STRUCT> -<TYPEDEF> -<NAME>CalQuery</NAME> -typedef struct { - GtkObject object; - - /* Private data */ - CalQueryPrivate *priv; -} CalQuery; -</TYPEDEF> -<FUNCTION> -<NAME>cal_query_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_query_construct</NAME> -<RETURNS>CalQuery *</RETURNS> -CalQuery *query,GNOME_Evolution_Calendar_Cal cal,const char *sexp -</FUNCTION> -<FUNCTION> -<NAME>cal_query_new</NAME> -<RETURNS>CalQuery *</RETURNS> -GNOME_Evolution_Calendar_Cal cal,const char *sexp -</FUNCTION> -<MACRO> -<NAME>QUERY_LISTENER_TYPE</NAME> -#define QUERY_LISTENER_TYPE (query_listener_get_type ()) -</MACRO> -<MACRO> -<NAME>QUERY_LISTENER</NAME> -#define QUERY_LISTENER(obj) (GTK_CHECK_CAST ((obj), QUERY_LISTENER_TYPE, QueryListener)) -</MACRO> -<MACRO> -<NAME>QUERY_LISTENER_CLASS</NAME> -#define QUERY_LISTENER_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), QUERY_LISTENER_TYPE, \ - QueryListenerClass)) -</MACRO> -<MACRO> -<NAME>IS_QUERY_LISTENER</NAME> -#define IS_QUERY_LISTENER(obj) (GTK_CHECK_TYPE ((obj), QUERY_LISTENER_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_QUERY_LISTENER_CLASS</NAME> -#define IS_QUERY_LISTENER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), QUERY_LISTENER_TYPE)) -</MACRO> -<STRUCT> -<NAME>QueryListenerPrivate</NAME> -</STRUCT> -<TYPEDEF> -<NAME>QueryListener</NAME> -typedef struct { - BonoboXObject xobject; - - /* Private data */ - QueryListenerPrivate *priv; -} QueryListener; -</TYPEDEF> -<USER_FUNCTION> -<NAME>QueryListenerObjUpdatedFn</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql, - const GNOME_Evolution_Calendar_CalObjUID uid, - CORBA_boolean query_in_progress, - CORBA_long n_scanned, - CORBA_long total, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>QueryListenerObjRemovedFn</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql, - const GNOME_Evolution_Calendar_CalObjUID uid, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>QueryListenerQueryDoneFn</NAME> -<RETURNS>void </RETURNS> - - QueryListener *ql, - GNOME_Evolution_Calendar_QueryListener_QueryDoneStatus status, - const CORBA_char *error_str, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>QueryListenerEvalErrorFn</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql, - const CORBA_char *error_str, - gpointer data -</USER_FUNCTION> -<FUNCTION> -<NAME>query_listener_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>query_listener_construct</NAME> -<RETURNS>QueryListener *</RETURNS> -QueryListener *ql,QueryListenerObjUpdatedFn obj_updated_fn,QueryListenerObjRemovedFn obj_removed_fn,QueryListenerQueryDoneFn query_done_fn,QueryListenerEvalErrorFn eval_error_fn,gpointer fn_data -</FUNCTION> -<FUNCTION> -<NAME>query_listener_new</NAME> -<RETURNS>QueryListener *</RETURNS> -QueryListenerObjUpdatedFn obj_updated_fn,QueryListenerObjRemovedFn obj_removed_fn,QueryListenerQueryDoneFn query_done_fn,QueryListenerEvalErrorFn eval_error_fn,gpointer fn_data -</FUNCTION> -<FUNCTION> -<NAME>query_listener_stop_notification</NAME> -<RETURNS>void </RETURNS> -QueryListener *ql -</FUNCTION> diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml b/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml deleted file mode 100644 index 136cf77e5c..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-docs.sgml +++ /dev/null @@ -1,15 +0,0 @@ -<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!ENTITY CalClient SYSTEM "sgml/cal-client.sgml"> -<!ENTITY evolution-cal-client-CalQuery SYSTEM "sgml/cal-query.sgml"> -]> -<book id="index"> - <bookinfo> - <title>[Insert name here] Reference Manual</title> - </bookinfo> - - <chapter> - <title>[Insert title here]</title> - &CalClient; - &evolution-cal-client-CalQuery; - </chapter> -</book> 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 8e33be4933..0000000000 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ /dev/null @@ -1,69 +0,0 @@ -<INCLUDE>cal-client/cal-client.h</INCLUDE> - -<SECTION> -<FILE>cal-client</FILE> -CAL_CLIENT -<TITLE>CalClient</TITLE> - -CalClientOpenStatus -CalClientGetStatus -CalClientLoadState - -CalClientChangeType - -cal_client_new -cal_client_open_calendar -cal_client_get_load_state -cal_client_get_uri -cal_client_get_n_objects -cal_client_get_uids -cal_client_get_object -cal_client_get_changes -cal_client_change_list_free -cal_client_get_objects_in_range -cal_client_generate_instances -cal_client_get_alarms_in_range -cal_client_free_alarms -cal_client_get_alarms_for_object -cal_client_update_object -cal_client_remove_object -cal_client_get_query - -<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 -CalClientPrivate - -</SECTION> - - -<SECTION> -<FILE>cal-query</FILE> -CAL_QUERY -<TITLE>CalQuery</TITLE> - -CalQueryDoneStatus -cal_query_new - -<SUBSECTION Standard> - -CAL_QUERY_TYPE -IS_CAL_QUERY -CAL_QUERY_CLASS -IS_CAL_QUERY_CLASS -cal_query_get_type -cal_query_construct - -<SUBSECTION Private> -CalQuery -CalQueryPrivate - -</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.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 4426d6c478..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ /dev/null @@ -1,338 +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. The - CORBA interfaces transfer calendar components in RFC 2445 text - format; the #CalClient object automatically converts these into - #CalComponent structures that are easier to handle. - </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> - #CalComponent - </para> - -<!-- ##### MACRO CAL_CLIENT ##### --> - <para> - Casts a #GtkObject to a #CalClient. - </para> - -@obj: A GTK+ object. - - -<!-- ##### ENUM CalClientOpenStatus ##### --> -<para> - -</para> - -@CAL_CLIENT_OPEN_SUCCESS: -@CAL_CLIENT_OPEN_ERROR: -@CAL_CLIENT_OPEN_NOT_FOUND: -@CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED: - -<!-- ##### ENUM CalClientGetStatus ##### --> - <para> - These values describe the result of the cal_client_get_object() - function. - </para> - -@CAL_CLIENT_GET_SUCCESS: -@CAL_CLIENT_GET_NOT_FOUND: -@CAL_CLIENT_GET_SYNTAX_ERROR: - -<!-- ##### ENUM CalClientLoadState ##### --> -<para> - -</para> - -@CAL_CLIENT_LOAD_NOT_LOADED: -@CAL_CLIENT_LOAD_LOADING: -@CAL_CLIENT_LOAD_LOADED: - -<!-- ##### ENUM CalClientChangeType ##### --> -<para> - -</para> - -@CAL_CLIENT_CHANGE_ADDED: -@CAL_CLIENT_CHANGE_MODIFIED: -@CAL_CLIENT_CHANGE_DELETED: - -<!-- ##### FUNCTION cal_client_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cal_client_open_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@only_if_exists: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_load_state ##### --> -<para> - -</para> - -@client: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_uri ##### --> -<para> - -</para> - -@client: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_n_objects ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_uids ##### --> -<para> - -</para> - -@client: -@type: -@Returns: - - -<!-- ##### FUNCTION cal_client_get_object ##### --> -<para> - -</para> - -@client: -@uid: -@comp: -@Returns: -<!-- # Unused Parameters # --> -@ico: - - -<!-- ##### FUNCTION cal_client_get_changes ##### --> -<para> - -</para> - -@client: -@type: -@change_id: -@Returns: - - -<!-- ##### FUNCTION cal_client_change_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### 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_alarms_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - - -<!-- ##### FUNCTION cal_client_free_alarms ##### --> -<para> - -</para> - -@comp_alarms: - - -<!-- ##### 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: - - -<!-- ##### FUNCTION cal_client_get_query ##### --> -<para> - -</para> - -@client: -@sexp: -@Returns: - - -<!-- ##### SIGNAL CalClient::cal-opened ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL CalClient::cal-set-mode ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: -@arg2: - -<!-- ##### 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: ---> - -<!-- ##### SIGNAL CalClient::categories-changed ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL CalClient::forget-password ##### --> -<para> - -</para> - -@calclient: the object which received the signal. -@arg1: - 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 3e8ce25ee6..0000000000 --- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ /dev/null @@ -1,84 +0,0 @@ -<!-- ##### 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: -@client: Calendar client which received the notification. -@status: Status of the request. See the description of - #CalClientLoadStatus for more details. - -<!-- ##### 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> - - -<!-- ##### FUNCTION cal_client_create_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - -<!-- ##### FUNCTION cal_client_get_events_in_range ##### --> -<para> - -</para> - -@client: -@start: -@end: -@Returns: - -<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### --> -<para> - -</para> - -@client: -@pilot_id: -@uid: -@Returns: - -<!-- ##### FUNCTION cal_client_is_loaded ##### --> -<para> - -</para> - -@client: -@Returns: - -<!-- ##### FUNCTION cal_client_load_calendar ##### --> -<para> - -</para> - -@client: -@str_uri: -@Returns: - -<!-- ##### FUNCTION cal_client_update_pilot_id ##### --> -<para> - -</para> - -@client: -@uid: -@pilot_id: -@pilot_status: - diff --git a/doc/devel/calendar/cal-util/.cvsignore b/doc/devel/calendar/cal-util/.cvsignore deleted file mode 100644 index 4c0883da0a..0000000000 --- a/doc/devel/calendar/cal-util/.cvsignore +++ /dev/null @@ -1,12 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*-undocumented.txt -*.signals -*.hierarchy -*.stamp -*-scan.c -.libs diff --git a/doc/devel/calendar/cal-util/Makefile.am b/doc/devel/calendar/cal-util/Makefile.am deleted file mode 100644 index fa5effcb31..0000000000 --- a/doc/devel/calendar/cal-util/Makefile.am +++ /dev/null @@ -1,196 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-cal-util - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - -# Used for dependencies. -HFILE_GLOB= \ - $(top_srcdir)/calendar/cal-util/cal-component.h \ - $(top_srcdir)/calendar/cal-util/cal-recur.h \ - $(top_srcdir)/calendar/cal-util/cal-util.h \ - $(top_srcdir)/calendar/cal-util/timeutil.h - -CFILE_GLOB= \ - $(top_srcdir)/calendar/cal-util/cal-component.c \ - $(top_srcdir)/calendar/cal-util/cal-recur.c \ - $(top_srcdir)/calendar/cal-util/cal-util.c \ - $(top_srcdir)/calendar/cal-util/timeutil.c - - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - calobj.h - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_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) - -GTKDOC_LIBS = \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-util/.libs/libcal-util-static.al \ - $(top_builddir)/libical/src/libical/.libs/libical-static.al \ - $(top_builddir)/libversit/.libs/libversit.al - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -all-local: sgml-build.stamp -#all-local: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -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); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - files=`echo $(srcdir)/tmpl/*.sgml` ; \ - test '$(srcdir)/tmpl/*.sgml' = "$$files" \ - || cp $$files $(distdir)/tmpl - files=`echo $(srcdir)/sgml/*.sgml` ; \ - test '$(srcdir)/sgml/*.sgml' = "$$files" \ - || cp $$files $(distdir)/sgml - -.PHONY : dist-hook-local
\ No newline at end of file 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 77268db8b1..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ /dev/null @@ -1,1007 +0,0 @@ -<USER_FUNCTION> -<NAME>CalRecurInstanceFn</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp, - time_t instance_start, - time_t instance_end, - gpointer data -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>CalRecurResolveTimezoneFn</NAME> -<RETURNS>icaltimezone *</RETURNS> -const char *tzid, - 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,CalRecurResolveTimezoneFn tz_cb,gpointer tz_cb_data,icaltimezone *default_timezone -</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> -<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> -<ENUM> -<NAME>CalMode</NAME> -typedef enum { - CAL_MODE_INVALID = -1, - CAL_MODE_LOCAL = 1 << 0, - CAL_MODE_REMOTE = 1 << 1, - CAL_MODE_ANY = 0x07 -} CalMode; -</ENUM> -<FUNCTION> -<NAME>cal_obj_uid_list_free</NAME> -<RETURNS>void </RETURNS> -GList *list -</FUNCTION> -<FUNCTION> -<NAME>cal_util_new_top_level</NAME> -<RETURNS>icalcomponent *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_util_generate_alarms_for_comp</NAME> -<RETURNS>CalComponentAlarms *</RETURNS> -CalComponent *comp,time_t start,time_t end,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone -</FUNCTION> -<FUNCTION> -<NAME>cal_util_generate_alarms_for_list</NAME> -<RETURNS>int </RETURNS> -GList *comps,time_t start,time_t end,GSList **comp_alarms,CalRecurResolveTimezoneFn resolve_tzid,gpointer user_data,icaltimezone *default_timezone -</FUNCTION> -<FUNCTION> -<NAME>cal_util_resolve_tzid</NAME> -<RETURNS>icaltimezone *</RETURNS> -const char *tzid, gpointer data -</FUNCTION> -<FUNCTION> -<NAME>cal_util_priority_to_string</NAME> -<RETURNS>char *</RETURNS> -int priority -</FUNCTION> -<FUNCTION> -<NAME>cal_util_priority_from_string</NAME> -<RETURNS>int </RETURNS> -const char *string -</FUNCTION> -<FUNCTION> -<NAME>time_days_in_month</NAME> -<RETURNS>int </RETURNS> -int year, int month -</FUNCTION> -<FUNCTION> -<NAME>time_day_of_year</NAME> -<RETURNS>int </RETURNS> -int day, int month, int year -</FUNCTION> -<FUNCTION> -<NAME>time_day_of_week</NAME> -<RETURNS>int </RETURNS> -int day, int month, int year -</FUNCTION> -<FUNCTION> -<NAME>time_is_leap_year</NAME> -<RETURNS>gboolean </RETURNS> -int year -</FUNCTION> -<FUNCTION> -<NAME>time_leap_years_up_to</NAME> -<RETURNS>int </RETURNS> -int year -</FUNCTION> -<FUNCTION> -<NAME>isodate_from_time_t</NAME> -<RETURNS>char *</RETURNS> -time_t t -</FUNCTION> -<FUNCTION> -<NAME>time_from_isodate</NAME> -<RETURNS>time_t </RETURNS> -const char *str -</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_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>time_add_day_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int days, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_add_week_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int weeks, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_add_month_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int months, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_year_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_month_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_week_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, int week_start_day,icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_day_begin_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_day_end_with_zone</NAME> -<RETURNS>time_t </RETURNS> -time_t time, icaltimezone *zone -</FUNCTION> -<FUNCTION> -<NAME>time_to_gdate_with_zone</NAME> -<RETURNS>void </RETURNS> -GDate *date, time_t time, icaltimezone *zone -</FUNCTION> -<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_STATUS, - CAL_COMPONENT_FIELD_COMPONENT, /* not a real field */ - CAL_COMPONENT_FIELD_LOCATION, - 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> -<ENUM> -<NAME>CalComponentRangeType</NAME> -typedef enum { - CAL_COMPONENT_RANGE_SINGLE, - CAL_COMPONENT_RANGE_THISPRIOR, - CAL_COMPONENT_RANGE_THISFUTURE, -} CalComponentRangeType; -</ENUM> -<TYPEDEF> -<NAME>CalComponentRange</NAME> -typedef struct { - CalComponentRangeType type; - - CalComponentDateTime *datetime; -} CalComponentRange; -</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> -<TYPEDEF> -<NAME>CalComponentAttendee</NAME> -typedef struct { - const char *value; - - const char *member; - icalparameter_cutype cutype; - icalparameter_role role; - icalparameter_partstat status; - gboolean rsvp; - - const char *delto; - const char *delfrom; - const char *sentby; - const char *cn; - const char *language; -} CalComponentAttendee; -</TYPEDEF> -<TYPEDEF> -<NAME>CalComponentOrganizer</NAME> -typedef struct { - const char *value; - const char *sentby; - const char *cn; - const char *language; -} CalComponentOrganizer; -</TYPEDEF> -<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_rescan</NAME> -<RETURNS>void </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</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **categories -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_categories</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *categories -</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_contact_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **text_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_contact_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *text_list -</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_has_exdates</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_exrule_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **recur_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_exrule_property_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_has_exrules</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_exceptions</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</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_organizer</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentOrganizer *organizer -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_organizer</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentOrganizer *organizer -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_organizer</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</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_recurid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentRange **recur_id -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_recurid</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentRange *recur_id -</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_get_rrule_property_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_has_recurrences</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_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, icalproperty_status *status -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_status</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, icalproperty_status status -</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_attendee_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList **attendee_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_attendee_list</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, GSList *attendee_list -</FUNCTION> -<FUNCTION> -<NAME>cal_component_has_attendees</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_location</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char **location -</FUNCTION> -<FUNCTION> -<NAME>cal_component_set_location</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *location -</FUNCTION> -<FUNCTION> -<NAME>cal_component_event_dates_match</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp1, CalComponent *comp2 -</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> -<FUNCTION> -<NAME>cal_component_free_attendee_list</NAME> -<RETURNS>void </RETURNS> -GSList *attendee_list -</FUNCTION> -<STRUCT> -<NAME>CalComponentAlarm</NAME> -</STRUCT> -<TYPEDEF> -<NAME>CalAlarmInstance</NAME> -typedef struct { - /* UID of the alarm that triggered */ - const char *auid; - - /* Trigger time, i.e. "5 minutes before the appointment" */ - time_t trigger; - - /* Actual event occurrence to which this trigger corresponds */ - time_t occur_start; - time_t occur_end; -} CalAlarmInstance; -</TYPEDEF> -<TYPEDEF> -<NAME>CalComponentAlarms</NAME> -typedef struct { - /* The actual component */ - CalComponent *comp; - - /* List of CalAlarmInstance structures */ - GSList *alarms; -} CalComponentAlarms; -</TYPEDEF> -<ENUM> -<NAME>CalAlarmAction</NAME> -typedef enum { - CAL_ALARM_NONE, - CAL_ALARM_AUDIO, - CAL_ALARM_DISPLAY, - CAL_ALARM_EMAIL, - CAL_ALARM_PROCEDURE, - CAL_ALARM_UNKNOWN -} CalAlarmAction; -</ENUM> -<ENUM> -<NAME>CalAlarmTriggerType</NAME> -typedef enum { - CAL_ALARM_TRIGGER_NONE, - CAL_ALARM_TRIGGER_RELATIVE_START, - CAL_ALARM_TRIGGER_RELATIVE_END, - CAL_ALARM_TRIGGER_ABSOLUTE -} CalAlarmTriggerType; -</ENUM> -<TYPEDEF> -<NAME>CalAlarmTrigger</NAME> -typedef struct { - CalAlarmTriggerType type; - - union { - struct icaldurationtype rel_duration; - struct icaltimetype abs_time; - } u; -} CalAlarmTrigger; -</TYPEDEF> -<TYPEDEF> -<NAME>CalAlarmRepeat</NAME> -typedef struct { - /* Number of extra repetitions, zero for none */ - int repetitions; - - /* Interval between repetitions */ - struct icaldurationtype duration; -} CalAlarmRepeat; -</TYPEDEF> -<FUNCTION> -<NAME>cal_component_has_alarms</NAME> -<RETURNS>gboolean </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_add_alarm</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_remove_alarm</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp, const char *auid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_remove_all_alarms</NAME> -<RETURNS>void </RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_alarm_uids</NAME> -<RETURNS>GList *</RETURNS> -CalComponent *comp -</FUNCTION> -<FUNCTION> -<NAME>cal_component_get_alarm</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -CalComponent *comp, const char *auid -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarms_free</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarms *alarms -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_new</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_clone</NAME> -<RETURNS>CalComponentAlarm *</RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_free</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_uid</NAME> -<RETURNS>const char *</RETURNS> -CalComponentAlarm *alarm -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_action</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmAction *action -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_action</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmAction action -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_attach</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, icalattach **attach -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_attach</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, icalattach *attach -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_description</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentText *description -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_description</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalComponentText *description -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_repeat</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmRepeat *repeat -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_repeat</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmRepeat repeat -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_get_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmTrigger *trigger -</FUNCTION> -<FUNCTION> -<NAME>cal_component_alarm_set_trigger</NAME> -<RETURNS>void </RETURNS> -CalComponentAlarm *alarm, CalAlarmTrigger trigger -</FUNCTION> diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml b/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml deleted file mode 100644 index bab3cac78e..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-docs.sgml +++ /dev/null @@ -1,19 +0,0 @@ -<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!ENTITY CalComponent SYSTEM "sgml/cal-component.sgml"> -<!ENTITY evolution-cal-util-cal-recur SYSTEM "sgml/cal-recur.sgml"> -<!ENTITY evolution-cal-util-cal-util SYSTEM "sgml/cal-util.sgml"> -<!ENTITY evolution-cal-util-timeutil SYSTEM "sgml/timeutil.sgml"> -]> -<book id="index"> - <bookinfo> - <title>[Insert name here] Reference Manual</title> - </bookinfo> - - <chapter> - <title>[Insert title here]</title> - &CalComponent; - &evolution-cal-util-cal-recur; - &evolution-cal-util-cal-util; - &evolution-cal-util-timeutil; - </chapter> -</book> 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 1a03226591..0000000000 --- a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ /dev/null @@ -1,161 +0,0 @@ -<SECTION> -<FILE>cal-component</FILE> -CAL_COMPONENT -<TITLE>CalComponent</TITLE> - -CalComponentVType -CalComponentField -CalComponentClassification -CalComponentDateTime -CalComponentPeriodType -CalComponentPeriod -CalComponentText -CalComponentTransparency - -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 -cal_component_set_categories -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_has_exdates -cal_component_get_exrule_list -cal_component_get_exrule_property_list -cal_component_set_exrule_list -cal_component_has_exrules -cal_component_has_exceptions -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_get_rrule_property_list -cal_component_set_rrule_list -cal_component_has_rrules -cal_component_has_recurrences -cal_component_get_sequence -cal_component_set_sequence -cal_component_get_status -cal_component_set_status -cal_component_get_summary -cal_component_set_summary -cal_component_get_transparency -cal_component_set_transparency -cal_component_get_url -cal_component_set_url - -<SUBSECTION Functions to free returned values> -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 - -<SUBSECTION Alarms> -CalComponentAlarm -CalAlarmInstance -CalComponentAlarms -CalAlarmAction -CalAlarmTriggerType -CalAlarmTrigger - -cal_component_has_alarms -cal_component_get_alarm_uids -cal_component_get_alarm -cal_component_alarm_free -cal_component_alarms_free -cal_component_alarm_get_uid -cal_component_alarm_get_action -cal_component_alarm_set_action -cal_component_alarm_get_trigger -cal_component_alarm_set_trigger - -<SUBSECTION Standard> -CAL_COMPONENT_TYPE -CAL_COMPONENT_CLASS -IS_CAL_COMPONENT -IS_CAL_COMPONENT_CLASS -cal_component_get_type - -<SUBSECTION Private> -CalComponent -CalComponentPrivate - -</SECTION> - -<SECTION> -<FILE>cal-recur</FILE> -CalRecurInstanceFn -cal_recur_generate_instances -</SECTION> - -<SECTION> -<FILE>cal-util</FILE> -CalObjInstance -cal_obj_instance_list_free -CalObjType -cal_obj_uid_list_free -</SECTION> - -<SECTION> -<FILE>timeutil</FILE> -isodate_from_time_t -time_add_minutes -time_add_day -time_add_week -time_add_month -time_add_year -time_days_in_month -time_from_day -time_year_begin -time_year_end -time_month_begin -time_month_end -time_week_begin -time_week_end -time_day_begin -time_day_end -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 df864035e7..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ /dev/null @@ -1,994 +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: -@CAL_COMPONENT_EVENT: -@CAL_COMPONENT_TODO: -@CAL_COMPONENT_JOURNAL: -@CAL_COMPONENT_FREEBUSY: -@CAL_COMPONENT_TIMEZONE: - -<!-- ##### 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: -@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: -@CAL_COMPONENT_FIELD_ICON: -@CAL_COMPONENT_FIELD_COMPLETE: -@CAL_COMPONENT_FIELD_RECURRING: -@CAL_COMPONENT_FIELD_OVERDUE: -@CAL_COMPONENT_FIELD_COLOR: -@CAL_COMPONENT_FIELD_STATUS: -@CAL_COMPONENT_FIELD_COMPONENT: -@CAL_COMPONENT_FIELD_LOCATION: -@CAL_COMPONENT_FIELD_NUM_FIELDS: - -<!-- ##### ENUM CalComponentClassification ##### --> - <para> - Values for the access classification property of a calendar - component. - </para> - -@CAL_COMPONENT_CLASS_NONE: -@CAL_COMPONENT_CLASS_PUBLIC: -@CAL_COMPONENT_CLASS_PRIVATE: -@CAL_COMPONENT_CLASS_CONFIDENTIAL: -@CAL_COMPONENT_CLASS_UNKNOWN: - -<!-- ##### 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: -@CAL_COMPONENT_PERIOD_DURATION: - -<!-- ##### 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: - -<!-- ##### 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 ##### --> -<para> - -</para> - -@comp: -@categories: - - -<!-- ##### FUNCTION cal_component_set_categories ##### --> -<para> - -</para> - -@comp: -@categories: - - -<!-- ##### 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_has_exdates ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_exrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_get_exrule_property_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_set_exrule_list ##### --> -<para> - -</para> - -@comp: -@recur_list: - - -<!-- ##### FUNCTION cal_component_has_exrules ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_has_exceptions ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### 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_get_rrule_property_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_has_recurrences ##### --> -<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_status ##### --> -<para> - -</para> - -@comp: -@status: - - -<!-- ##### FUNCTION cal_component_set_status ##### --> -<para> - -</para> - -@comp: -@status: - - -<!-- ##### 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_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: - - -<!-- ##### STRUCT CalComponentAlarm ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CalAlarmInstance ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF CalComponentAlarms ##### --> -<para> - -</para> - - -<!-- ##### ENUM CalAlarmAction ##### --> -<para> - -</para> - -@CAL_ALARM_NONE: -@CAL_ALARM_AUDIO: -@CAL_ALARM_DISPLAY: -@CAL_ALARM_EMAIL: -@CAL_ALARM_PROCEDURE: -@CAL_ALARM_UNKNOWN: - -<!-- ##### ENUM CalAlarmTriggerType ##### --> -<para> - -</para> - -@CAL_ALARM_TRIGGER_NONE: -@CAL_ALARM_TRIGGER_RELATIVE_START: -@CAL_ALARM_TRIGGER_RELATIVE_END: -@CAL_ALARM_TRIGGER_ABSOLUTE: - -<!-- ##### TYPEDEF CalAlarmTrigger ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cal_component_has_alarms ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_alarm_uids ##### --> -<para> - -</para> - -@comp: -@Returns: - - -<!-- ##### FUNCTION cal_component_get_alarm ##### --> -<para> - -</para> - -@comp: -@auid: -@Returns: - - -<!-- ##### FUNCTION cal_component_alarm_free ##### --> -<para> - -</para> - -@alarm: - - -<!-- ##### FUNCTION cal_component_alarms_free ##### --> -<para> - -</para> - -@alarms: - - -<!-- ##### FUNCTION cal_component_alarm_get_uid ##### --> -<para> - -</para> - -@alarm: -@Returns: - - -<!-- ##### 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: - - 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 214b24cbf7..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ /dev/null @@ -1,45 +0,0 @@ -<!-- ##### SECTION Title ##### --> -cal-recur - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### USER_FUNCTION CalRecurInstanceFn ##### --> -<para> - -</para> - -@comp: -@instance_start: -@instance_end: -@data: -@Returns: -<!-- # Unused Parameters # --> -@instace_end: - - -<!-- ##### FUNCTION cal_recur_generate_instances ##### --> -<para> - -</para> - -@comp: -@start: -@end: -@cb: -@cb_data: -@tz_cb: -@tz_cb_data: -@default_timezone: - - 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 ccd35fac2e..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml +++ /dev/null @@ -1,48 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Miscellaneous utilities - -<!-- ##### 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: - - -<!-- ##### 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 757b46b170..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ /dev/null @@ -1,322 +0,0 @@ -<!-- ##### 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: - -<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### --> -<para> - -</para> - - -<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: - -<!-- ##### ENUM CalComponentAlarmTriggerType ##### --> -<para> - -</para> - -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: - -<!-- ##### STRUCT CalComponentPrivate ##### --> -<para> - -</para> - - -<!-- ##### STRUCT CalObjTime ##### --> -<para> - -</para> - -@year: -@month: -@day: -@hour: -@minute: -@second: - -<!-- ##### 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> - - -<!-- ##### FUNCTION cal_alarm_instance_list_free ##### --> -<para> - -</para> - -@list: - -<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### --> -<para> - -</para> - -@trigger: <!-- -Local variables: -mode: sgml -sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "") -End: ---> - -<!-- ##### FUNCTION cal_component_get_first_alarm ##### --> -<para> - -</para> - -@comp: -@Returns: - -<!-- ##### FUNCTION cal_component_get_next_alarm ##### --> -<para> - -</para> - -@comp: -@Returns: - -<!-- ##### FUNCTION cal_component_get_pilot_id ##### --> -<para> - -</para> - -@comp: -@pilot_id: - -<!-- ##### FUNCTION cal_component_get_pilot_status ##### --> -<para> - -</para> - -@comp: -@pilot_status: - -<!-- ##### FUNCTION cal_component_set_pilot_id ##### --> -<para> - -</para> - -@comp: -@pilot_id: - -<!-- ##### FUNCTION cal_component_set_pilot_status ##### --> -<para> - -</para> - -@comp: -@pilot_status: - -<!-- ##### FUNCTION cal_recur_free ##### --> -<para> - -</para> - -@r: - -<!-- ##### FUNCTION cal_recur_from_icalrecurrencetype ##### --> -<para> - -</para> - -@ir: -@Returns: - -<!-- ##### FUNCTION format_simple_hour ##### --> -<para> - -</para> - -@hour: -@use_am_pm: -@Returns: - -<!-- ##### FUNCTION get_time_t_hour ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION isodiff_from_secs ##### --> -<para> - -</para> - -@secs: -@Returns: - -<!-- ##### FUNCTION isodiff_to_secs ##### --> -<para> - -</para> - -@str: -@Returns: - -<!-- ##### FUNCTION parse_date ##### --> -<para> - -</para> - -@str: -@Returns: - -<!-- ##### FUNCTION print_time_t ##### --> -<para> - -</para> - -@t: - -<!-- ##### FUNCTION time_add_minutes ##### --> -<para> - -</para> - -@time: -@minutes: -@Returns: - -<!-- ##### FUNCTION time_add_month ##### --> -<para> - -</para> - -@time: -@months: -@Returns: - -<!-- ##### FUNCTION time_add_year ##### --> -<para> - -</para> - -@time: -@years: -@Returns: - -<!-- ##### FUNCTION time_day_hour ##### --> -<para> - -</para> - -@t: -@hour: -@Returns: - -<!-- ##### FUNCTION time_from_day ##### --> -<para> - -</para> - -@year: -@month: -@day: -@Returns: - -<!-- ##### 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 time_month_begin ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION time_month_end ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION time_week_begin ##### --> -<para> - -</para> - -@t: -@week_start_day: -@Returns: - -<!-- ##### FUNCTION time_week_end ##### --> -<para> - -</para> - -@t: -@week_start_day: -@Returns: - -<!-- ##### FUNCTION time_year_begin ##### --> -<para> - -</para> - -@t: -@Returns: - -<!-- ##### FUNCTION time_year_end ##### --> -<para> - -</para> - -@t: -@Returns: - 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 e118c438eb..0000000000 --- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml +++ /dev/null @@ -1,73 +0,0 @@ -<!-- ##### SECTION Title ##### --> -timeutil - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### FUNCTION isodate_from_time_t ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_add_day ##### --> -<para> - -</para> - -@time: -@days: -@Returns: - - -<!-- ##### FUNCTION time_add_week ##### --> -<para> - -</para> - -@time: -@weeks: -@Returns: - - -<!-- ##### FUNCTION time_days_in_month ##### --> -<para> - -</para> - -@year: -@month: -@Returns: - - -<!-- ##### FUNCTION time_day_begin ##### --> -<para> - -</para> - -@t: -@Returns: - - -<!-- ##### FUNCTION time_day_end ##### --> -<para> - -</para> - -@t: -@Returns: - - diff --git a/doc/devel/calendar/evolution-calendar.sgml b/doc/devel/calendar/evolution-calendar.sgml deleted file mode 100644 index ea0d8c7127..0000000000 --- a/doc/devel/calendar/evolution-calendar.sgml +++ /dev/null @@ -1,52 +0,0 @@ - <part id="evolution-calendar"> - <docinfo> - <authorgroup> - <author> - <firstname>Federico</firstname> - <surname>Mena Quintero</surname> - <affiliation> - <address> - <email>federico@ximian.com</email> - </address> - </affiliation> - </author> - </authorgroup> - </docinfo> - - <title>Developing Applications with 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. - This part also describes the internals of the calendar so that - it will be easy for you to make changes to &Evolution;'s core - code. - </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, such as its storage - interfaces and generic recurrence engine. If you intend to - make changes to the calendar's core code, it will be useful to - read the sections on the calendar internals as well. Even if - you do not intend to modify the core code of the calendar, it - may be useful to know a few things about the way it works so - that you can make better use of the public interfaces. - </para> - </partintro> - - &calendar-architecture; - &calendar-alarm-generation; - </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 b880bd2972..0000000000 --- a/doc/devel/calendar/public-reference.sgml +++ /dev/null @@ -1,24 +0,0 @@ - <reference id="calendar-public-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 c089c5b885..0000000000 --- a/doc/devel/evolution-devel-guide.sgml +++ /dev/null @@ -1,98 +0,0 @@ -<!DOCTYPE book PUBLIC "-//Davenport//DTD DocBook V3.0//EN"[ -<!ENTITY preface SYSTEM "preface.sgml"> -<!ENTITY evolution-reference SYSTEM "reference.sgml"> -<!ENTITY FDL SYSTEM "fdl.sgml"> - -<!ENTITY evolution-calendar SYSTEM "calendar/evolution-calendar.sgml"> -<!ENTITY calendar-architecture SYSTEM "calendar/architecture.sgml"> -<!ENTITY calendar-alarm-generation SYSTEM "calendar/alarm-generation.sgml"> -<!ENTITY calendar-public-reference SYSTEM "calendar/public-reference.sgml"> -<!ENTITY CalClient SYSTEM "calendar/cal-client/sgml/cal-client.sgml"> -<!ENTITY CalComponent SYSTEM "calendar/cal-util/sgml/cal-component.sgml"> -<!ENTITY cal-recur SYSTEM "calendar/cal-util/sgml/cal-recur.sgml"> -<!ENTITY cal-util SYSTEM "calendar/cal-util/sgml/cal-util.sgml"> -<!ENTITY timeutil SYSTEM "calendar/cal-util/sgml/timeutil.sgml"> - -<!ENTITY evolution-services-public-reference SYSTEM "executive-summary/public-reference.sgml"> -<!ENTITY evolution-services-private-reference SYSTEM "executive-summary/private-reference.sgml"> -<!ENTITY ExecutiveSummaryComponent SYSTEM "executive-summary/sgml/executive-summary-component.sgml"> -<!ENTITY ExecutiveSummaryComponentFactory SYSTEM "executive-summary/sgml/executive-summary-component-factory.sgml"> -<!ENTITY ExecutiveSummaryComponentFactoryClient SYSTEM "executive-summary/sgml/executive-summary-component-factory-client.sgml"> -<!ENTITY ExecutiveSummaryHtmlView SYSTEM "executive-summary/sgml/executive-summary-html-view.sgml"> - -<!ENTITY Evolution "<application>Evolution</application>"> -<!ENTITY Wombat "<application>Wombat</application>"> -<!ENTITY Camel "<application>Camel</application>"> -<!ENTITY PCS "<acronym>PCS</acronym>"> -<!ENTITY libical "<application>libical</application>"> -<!ENTITY Executive-Summary "<application>Executive Summary</application>"> -]> - -<!-- ENTITY importer-public-reference SYSTEM "importer/public-reference.sgml" --> -<!-- ENTITY importer-private-reference SYSTEM "importer/private-reference.sgml" --> -<!-- ENTITY EvolutionImporter SYSTEM "importer/sgml/evolution-importer.sgml" --> -<!-- ENTITY EvolutionImporterClient SYSTEM "importer/sgml/evolution-importer-client.sgml" --> -<!-- ENTITY EvolutionImporterListener SYSTEM "importer/sgml/evolution-importer-listener.sgml" --> - - -<book id="index"> - <bookinfo> - <title>&Evolution; Developer's Guide</title> - - <authorgroup> - <corpauthor> - Ximian, Inc. - </corpauthor> - </authorgroup> - - <copyright> - <year>2001</year> - <holder>Ximian, Inc.</holder> - </copyright> - - <copyright> - <year>2001</year> - <holder>Ximian, Inc.</holder> - </copyright> - - <legalnotice id="legalnotice"> - <para> - Permission is granted to copy, distribute and/or modify this - document under the terms of the <ulink type="help" - url="gnome-help:fdl"><citetitle>GNU Free Documentation - License</citetitle></ulink>, 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. You - may obtain a copy of the <citetitle>GNU Free Documentation - License</citetitle> 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> - </bookinfo> - - <!-- Introduction --> - - &preface; - - <!-- DocBook parts for each individual component --> - - &evolution-calendar; - - <!-- API Reference part --> - - &evolution-reference; - - <!-- Appendices --> - - &FDL; -</book> diff --git a/doc/devel/executive-summary/.cvsignore b/doc/devel/executive-summary/.cvsignore deleted file mode 100644 index 489a3d04fd..0000000000 --- a/doc/devel/executive-summary/.cvsignore +++ /dev/null @@ -1,12 +0,0 @@ -Makefile -Makefile.in -*-decl.txt -*.signals -*.hierarchy -*.stamp -*-scan.c -*-unused.txt -*-undocumented.txt -*-decl-list.txt -sgml - diff --git a/doc/devel/executive-summary/Makefile.am b/doc/devel/executive-summary/Makefile.am deleted file mode 100644 index 9e0901bd9f..0000000000 --- a/doc/devel/executive-summary/Makefile.am +++ /dev/null @@ -1,191 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-services - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/executive-summary/evolution-services - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - -# Used for dependencies. -HFILE_GLOB= -CFILE_GLOB= \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-component.c \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-component-factory-client.c \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-html-view.c - - -# Header files to ignore when scanning. -IGNORE_HFILES=Executive-Summary.h - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS = \ - -I$(top_srcdir)/executive-summary/evolution-services \ - -I$(top_srcdir)/executive-summary \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS = \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/executive-summary/evolution-services/.libs/libevolution-services.so - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -#all-local: html-build.stamp -all-local: sgml-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -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); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - mkdir $(distdir)/html - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml - -cp $(srcdir)/html/index.sgml $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -.PHONY : dist-hook-local diff --git a/doc/devel/executive-summary/evolution-services-decl.txt b/doc/devel/executive-summary/evolution-services-decl.txt deleted file mode 100644 index caaabb2ee7..0000000000 --- a/doc/devel/executive-summary/evolution-services-decl.txt +++ /dev/null @@ -1,536 +0,0 @@ -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLIENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_CLIENT_TYPE (executive_summary_client_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLIENT</NAME> -#define EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClient)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLIENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClientClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_CLIENT</NAME> -#define IS_EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_CLIENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryClientPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClient</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClientClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClient</NAME> -struct ExecutiveSummaryClient { - BonoboObjectClient parent; - - ExecutiveSummaryClientPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_construct</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,CORBA_Object object -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_set_title</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id,const char *title -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_set_icon</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_flash</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_client_update</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryClient *client,int id,const char *html -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE (executive_summary_component_client_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClient)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClientClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentClientPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClient</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClientClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClient</NAME> -struct ExecutiveSummaryComponentClient { - BonoboObjectClient parent; - - ExecutiveSummaryComponentClientPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_new</NAME> -<RETURNS>ExecutiveSummaryComponentClient *</RETURNS> -const char *id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_set_owner</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,ExecutiveSummary *summary -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_unset_owner</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_supports</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,gboolean *bonobo,gboolean *html -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_configure</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_client_destroy_view</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE (executive_summary_component_factory_client_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClient)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClientClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClientPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClient</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClientClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClient</NAME> -struct ExecutiveSummaryComponentFactoryClient { - BonoboObjectClient parent; - - ExecutiveSummaryComponentFactoryClientPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_factory_client_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_client_construct</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentFactoryClient *client,CORBA_Object corba_object -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_client_new</NAME> -<RETURNS>ExecutiveSummaryComponentFactoryClient *</RETURNS> -const char *id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_client_create_view</NAME> -<RETURNS>CORBA_Object </RETURNS> -ExecutiveSummaryComponentFactoryClient *client -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE (executive_summary_component_view_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentView)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentViewPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentView</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentViewClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentView</NAME> -struct ExecutiveSummaryComponentView { - GtkObject object; - - ExecutiveSummaryComponentViewPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_view_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_construct</NAME> -<RETURNS>void</RETURNS> -ExecutiveSummaryComponentView *view,ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_new</NAME> -<RETURNS>ExecutiveSummaryComponentView *</RETURNS> -ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_title</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,const char *title -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_title</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_icon</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,const char *icon -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_icon</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_flash</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_html</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,const char *html -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_html</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_control</NAME> -<RETURNS>BonoboObject *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_id</NAME> -<RETURNS>int </RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_id</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,int id -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_configure</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_set_objref</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryComponentView *view,Bonobo_Control objref -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_view_get_widget</NAME> -<RETURNS>GtkWidget *</RETURNS> -ExecutiveSummaryComponentView *view -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_TYPE (executive_summary_component_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponent)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponentClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponent</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponent</NAME> -struct ExecutiveSummaryComponent { - BonoboObject parent; - - ExecutiveSummaryComponentPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -void -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE (executive_summary_component_factory_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactory)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS</NAME> -#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactoryClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactory</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactoryClass</NAME> -</STRUCT> -<USER_FUNCTION> -<NAME>EvolutionServicesCreateViewFn</NAME> -<RETURNS>BonoboObject *</RETURNS> -ExecutiveSummaryComponentFactory *factory, - void *closure -</USER_FUNCTION> -<STRUCT> -<NAME>ExecutiveSummaryComponentFactory</NAME> -struct ExecutiveSummaryComponentFactory { - BonoboObject parent; - - ExecutiveSummaryComponentFactoryPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_component_factory_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_component_factory_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -EvolutionServicesCreateViewFn create_view,void *closure -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED "GNOME:Evolution:Summary:HTMLView:html_changed" -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_TYPE</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW_TYPE (executive_summary_html_view_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlView)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_CLASS</NAME> -#define EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlViewClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_HTML_VIEW</NAME> -#define IS_EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryHtmlViewPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryHtmlView</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryHtmlViewClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryHtmlView</NAME> -struct ExecutiveSummaryHtmlView { - BonoboObject parent; - - ExecutiveSummaryHtmlViewPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_html_view_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_new_full</NAME> -<RETURNS>BonoboObject *</RETURNS> -BonoboEventSource *event_source -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_set_html</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummaryHtmlView *view,const char *html -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_get_html</NAME> -<RETURNS>const char *</RETURNS> -ExecutiveSummaryHtmlView *view -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_html_view_get_event_source</NAME> -<RETURNS>BonoboEventSource *</RETURNS> -ExecutiveSummaryHtmlView *view -</FUNCTION> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_TYPE</NAME> -#define EXECUTIVE_SUMMARY_TYPE (executive_summary_get_type ()) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY</NAME> -#define EXECUTIVE_SUMMARY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummary)) -</MACRO> -<MACRO> -<NAME>EXECUTIVE_SUMMARY_CLASS</NAME> -#define EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummaryClass)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY</NAME> -#define IS_EXECUTIVE_SUMMARY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) -</MACRO> -<MACRO> -<NAME>IS_EXECUTIVE_SUMMARY_CLASS</NAME> -#define IS_EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) -</MACRO> -<STRUCT> -<NAME>ExecutiveSummaryPrivate</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummary</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummaryClass</NAME> -</STRUCT> -<STRUCT> -<NAME>ExecutiveSummary</NAME> -struct ExecutiveSummary { - BonoboObject parent; - - ExecutiveSummaryPrivate *private; -}; -</STRUCT> -<FUNCTION> -<NAME>executive_summary_get_type</NAME> -<RETURNS>GtkType </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_construct</NAME> -<RETURNS>void </RETURNS> -ExecutiveSummary *es,GNOME_Evolution_Summary_ViewFrame corba_object -</FUNCTION> -<FUNCTION> -<NAME>executive_summary_new</NAME> -<RETURNS>BonoboObject *</RETURNS> -void -</FUNCTION> diff --git a/doc/devel/executive-summary/evolution-services-sections.txt b/doc/devel/executive-summary/evolution-services-sections.txt deleted file mode 100644 index 8ba2b42317..0000000000 --- a/doc/devel/executive-summary/evolution-services-sections.txt +++ /dev/null @@ -1,95 +0,0 @@ -<INCLUDE>executive-summary-component.h</INCLUDE> -<SECTION> -<FILE>executive-summary-component</FILE> -EXECUTIVE_SUMMARY_COMPONENT -<TITLE>ExecutiveSummaryComponent</TITLE> - -executive_summary_component_new - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_COMPONENT_TYPE -EXECUTIVE_SUMMARY_COMPONENT -EXECUTIVE_SUMMARY_COMPONENT_CLASS -IS_EXECUTIVE_SUMMARY_COMPONENT -IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS -executive_summary_component_get_type - -<SUBSECTION Private> -ExecutiveSummaryComponent -ExecutiveSummaryComponentPrivate - -</SECTION> - -<SECTION> -<FILE>executive-summary-component-factory</FILE> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY -<TITLE>ExecutiveSummaryComponentFactory</TITLE> - -EvolutionServicesCreateViewFn - -executive_summary_component_factory_new - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE -EXECUTIVE_SUMMARY_COMPONENT_FACTORY -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS -executive_summary_component_factory_get_type - -<SUBSECTION Private> -ExecutiveSummaryComponentFactory -ExecutiveSummaryComponentFactoryPrivate - -</SECTION> - -<INCLUDE>executive-summary-component-factory-client.h</INCLUDE> -<SECTION> -<FILE>executive-summary-component-factory-client</FILE> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT -<TITLE>ExecutiveSummaryComponentFactoryClient</TITLE> - -executive_summary_component_factory_client_construct -executive_summary_component_factory_client_new -executive_summary_component_factory_client_create_view - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT -EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT -IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS -executive_summary_component_factory_client_get_type - -<SUBSECTION Private> -ExecutiveSummaryComponentFactoryClient -ExecutiveSummaryComponentFactoryClientPrivate - -</SECTION> - -<INCLUDE>executive-summary-html-view.h</INCLUDE> -<SECTION> -<FILE>executive-summary-html-view</FILE> -EXECUTIVE_SUMMARY_HTML_VIEW -<TITLE>ExecutiveSummaryHtmlView</TITLE> - -EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED - -executive_summary_html_view_new_full -executive_summary_html_view_new -executive_summary_html_view_set_html -executive_summary_html_view_get_html -executive_summary_html_view_get_event_source - -<SUBSECTION Standard> -EXECUTIVE_SUMMARY_HTML_VIEW_TYPE -EXECUTIVE_SUMMARY_HTML_VIEW -IS_EXECUTIVE_SUMMARY_HTML_VIEW -EXECUTIVE_SUMMARY_HTML_VIEW_CLASS -IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS -executive_summary_html_view_get_type - -<SUBSECTION Private> -ExecutiveSummaryHtmlView -ExecutiveSummaryHtmlViewPrivate -</SECTION> diff --git a/doc/devel/executive-summary/evolution-services.args b/doc/devel/executive-summary/evolution-services.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/executive-summary/evolution-services.args +++ /dev/null diff --git a/doc/devel/executive-summary/evolution-services.hierarchy b/doc/devel/executive-summary/evolution-services.hierarchy deleted file mode 100644 index 37559d819d..0000000000 --- a/doc/devel/executive-summary/evolution-services.hierarchy +++ /dev/null @@ -1,7 +0,0 @@ -GtkObject - BonoboObject - ExecutiveSummaryComponent - ExecutiveSummaryComponentFactory - Handle to remote Bonobo::Unknown - ExecutiveSummaryComponentFactoryClient - ExecutiveSummaryHtmlView diff --git a/doc/devel/executive-summary/evolution-services.types b/doc/devel/executive-summary/evolution-services.types deleted file mode 100644 index b7ac05b89c..0000000000 --- a/doc/devel/executive-summary/evolution-services.types +++ /dev/null @@ -1,10 +0,0 @@ -#include <gnome.h> -#include <bonobo.h> -#include <evolution-services/executive-summary-component.h> -#include <evolution-services/executive-summary-component-factory-client.h> -#include <evolution-services/executive-summary-html-view.h> - -executive_summary_component_get_type -executive_summary_component_factory_get_type -executive_summary_component_factory_client_get_type -executive_summary_html_view_get_type diff --git a/doc/devel/executive-summary/private-reference.sgml b/doc/devel/executive-summary/private-reference.sgml deleted file mode 100644 index e06d7c1690..0000000000 --- a/doc/devel/executive-summary/private-reference.sgml +++ /dev/null @@ -1,20 +0,0 @@ - <reference id="evolution-services-private-reference"> - <title>Evolution Services Private API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - private APIs of the different components of the &Evolution; - Executive Summary Services Framework. - </para> - </partintro> - - &ExecutiveSummaryComponentFactoryClient; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/executive-summary/public-reference.sgml b/doc/devel/executive-summary/public-reference.sgml deleted file mode 100644 index 7758a9a5c8..0000000000 --- a/doc/devel/executive-summary/public-reference.sgml +++ /dev/null @@ -1,22 +0,0 @@ - <reference id="evolution-services-public-reference"> - <title>Evolution Services 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; - Executive Summary Services Framework. - </para> - </partintro> - - &ExecutiveSummaryComponent; - &ExecutiveSummaryComponentFactory; - &ExecutiveSummaryHtmlView; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml b/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml deleted file mode 100644 index 9f8096db6a..0000000000 --- a/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml +++ /dev/null @@ -1,8 +0,0 @@ -<!-- ##### SIGNAL ExecutiveSummaryHtmlView::handle-uri ##### --> -<para> - -</para> - -@executivesummaryhtmlview: the object which received the signal. -@arg1: - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml deleted file mode 100644 index ee8ef25689..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml +++ /dev/null @@ -1,53 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryComponentFactoryClient - -<!-- ##### SECTION Short_Description ##### --> -GtkObject client to simplfy use of GNOME_Evolution_Summary_ComponentFactory - -<!-- ##### SECTION Long_Description ##### --> -<para> -This object provides an easy wrapper around the CORBA object that represents the - GNOME_Evolution_Summary_ComponentFactory interface. It handles conversion from -normal types to CORBA types and has error checking. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT ##### --> -<para> -Casts a #GtkObject into an #ExecutiveSummaryComponentFactoryClient -</para> - -@obj: - - -<!-- ##### FUNCTION executive_summary_component_factory_client_construct ##### --> -<para> - -</para> - -@client: -@corba_object: - - -<!-- ##### FUNCTION executive_summary_component_factory_client_new ##### --> -<para> - -</para> - -@id: -@Returns: - - -<!-- ##### FUNCTION executive_summary_component_factory_client_create_view ##### --> -<para> - -</para> - -@client: -@Returns: - - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml deleted file mode 100644 index 7069eea9d0..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml +++ /dev/null @@ -1,46 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryComponentFactory - -<!-- ##### SECTION Short_Description ##### --> -GtkObject wrapper for GNOME/Evolution/Summary/ComponentFactory. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An ExecutiveSummaryComponentFactory simplifies the creation of a -GNOME_Evolution_Summary_ComponentFactory object. It also allows error checking -and all the standard #GtkObject signals. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT_FACTORY ##### --> -<para> -Casts a #GtkObject to an #ExecutiveSummaryComponentFactory. -</para> - -@obj: A #GtkObject. - - -<!-- ##### USER_FUNCTION EvolutionServicesCreateViewFn ##### --> -<para> -The type of function that is called when the factory has to create a new view. -</para> - -@factory: The #ExecutiveSummaryComponent that is creating the view. -@closure: The data that was passed into executive_summary_factory_new (). -@Returns: An #ExecutiveSummaryComponent. - - -<!-- ##### FUNCTION executive_summary_component_factory_new ##### --> -<para> - -</para> - -@create_view: -@closure: -@Returns: - - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component.sgml deleted file mode 100644 index 04768b1b1c..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-component.sgml +++ /dev/null @@ -1,37 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryComponent - -<!-- ##### SECTION Short_Description ##### --> -The base #BonoboObject that implements GNOME/Evolution/Summary/Component. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This #GtkObject wrapper around the GNOME/Evolution/Summary/Component, is the -base object that has all the other interfaces aggregated onto it. These -interfaces are: GNOME/Evolution/HTMLView, Bonobo/Control, Bonobo/EventSource, -Bonobo/PropertyBag, Bonobo/PropertyControl and Bonobo/PersistStream. Each of -the aggregated interfaces performs a specific job in the creation of the service. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#ExecutiveSummaryHtmlView, #BonoboControl, #BonoboEventSource, #BonoboPropertyBag, -#BonoboPropertyControl, #BonoboPersistStream. -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT ##### --> -<para> -Casts a #GtkObject to an #ExecutiveSummaryComponent. -</para> - -@obj: A #GtkObject. - - -<!-- ##### FUNCTION executive_summary_component_new ##### --> -<para> - -</para> - -@Returns: - - diff --git a/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml b/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml deleted file mode 100644 index 2fb66a2035..0000000000 --- a/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml +++ /dev/null @@ -1,75 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ExecutiveSummaryHtmlView - -<!-- ##### SECTION Short_Description ##### --> -A Bonobo component used to implement HTML based services. - -<!-- ##### SECTION Long_Description ##### --> -<para> -When writing HTML services, this component is aggregated onto an #ExecutiveSummaryComponent, to allow the Executive Summary to be able to find the HTML. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#ExecutiveSummaryComponent, #BonoboEventSource -</para> - -<!-- ##### MACRO EXECUTIVE_SUMMARY_HTML_VIEW ##### --> -<para> - Casts a #GtkObject into an #ExecutiveSummaryHtmlView -</para> - -@obj: A #GtkObject - - -<!-- ##### MACRO EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED ##### --> -<para> -This is the event that is emitted on the BonoboEventSource when the HTML is changed. -</para> - - - -<!-- ##### FUNCTION executive_summary_html_view_new_full ##### --> -<para> - -</para> - -@event_source: -@Returns: - - -<!-- ##### FUNCTION executive_summary_html_view_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION executive_summary_html_view_set_html ##### --> -<para> - -</para> - -@view: -@html: - - -<!-- ##### FUNCTION executive_summary_html_view_get_html ##### --> -<para> - -</para> - -@view: -@Returns: - - -<!-- ##### FUNCTION executive_summary_html_view_get_event_source ##### --> -<para> - -</para> - -@view: -@Returns: - - diff --git a/doc/devel/fdl.sgml b/doc/devel/fdl.sgml deleted file mode 100644 index 817adbdbb7..0000000000 --- a/doc/devel/fdl.sgml +++ /dev/null @@ -1,671 +0,0 @@ -<!-- - The GNU Free Documentation License 1.1 in DocBook - Markup by Eric Baudais <baudais@okstate.edu> - Maintained by the GNOME Documentation Project - http://developer.gnome.org/projects/gdp - Version: 1.0.1 - Last Modified: Nov 16, 2000 ---> - -<appendix id="fdl"> - <docinfo> - <releaseinfo> - Version 1.1, March 2000 - </releaseinfo> - <copyright> - <year>2000</year><holder>Free Software Foundation, Inc.</holder> - </copyright> - <legalnotice id="fdl-legalnotice"> - <para> - <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> - </legalnotice> - </docinfo> - <title>GNU Free Documentation License</title> - - <sect1 id="fdl-preamble"> - <title>0. PREAMBLE</title> - <para> - The purpose of this License is to make a manual, textbook, or - other written document <quote>free</quote> 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 <quote>copyleft</quote>, 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> - </sect1> - <sect1 id="fdl-section1"> - <title>1. APPLICABILITY AND DEFINITIONS</title> - <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 - <quote>Document</quote>, below, refers to any such manual or - work. Any member of the public is a licensee, and is addressed - as <quote>you</quote>. - </para> - - <para id="fdl-modified"> - A <quote>Modified Version</quote> 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 <quote>Secondary Section</quote> 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 - Document to the Document's overall subject (or to related - matters) and contains nothing that could fall directly within - that overall subject. (For example, if the Document is in part a - textbook of mathematics, a Secondary Section 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 <quote>Invariant Sections</quote> are certain <link - linkend="fdl-secondary"> Secondary Sections</link> whose titles - are designated, as being those of Invariant Sections, 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 <quote>Cover Texts</quote> are certain short passages of - text that are listed, as Front-Cover Texts or Back-Cover Texts, - in the notice that says that the <link - linkend="fdl-document">Document</link> is released under this - License. - </para> - - <para id="fdl-transparent"> - A <quote>Transparent</quote> 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 Transparent file format - whose markup has been designed to thwart or discourage - subsequent modification by readers is not Transparent. A copy - that is not <quote>Transparent</quote> is called - <quote>Opaque</quote>. - </para> - - <para> - Examples of suitable formats for Transparent 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 <quote>Title Page</quote> 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, <quote>Title Page</quote> means the text near the - most prominent appearance of the work's title, preceding the - beginning of the body of the text. - </para> - </sect1> - - <sect1 id="fdl-section2"> - <title>2. VERBATIM COPYING</title> - <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 Document 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> - </sect1> - - <sect1 id="fdl-section3"> - <title>3. COPYING IN QUANTITY</title> - <para> - If you publish printed copies of the <link - linkend="fdl-document">Document</link> numbering more than 100, - and the Document's 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 - Cover Texts: 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 Opaque copy, or state in or with each Opaque copy a - publicly-accessible computer-network location containing a - complete Transparent copy of the Document, 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 Opaque - copies in quantity, to ensure that this Transparent copy will - remain thus accessible at the stated location until at least one - year after the last time you distribute an Opaque 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 Document. - </para> - </sect1> - - <sect1 id="fdl-section4"> - <title>4. MODIFICATIONS</title> - <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 Modified Version under precisely this License, with the - Modified Version filling the role of the Document, thus - licensing distribution and modification of the Modified Version - to whoever possesses a copy of it. In addition, you must do - these things in the Modified Version: - </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 Document). 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 <quote>History</quote>, 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 <quote>History</quote> in the - <link linkend="fdl-document">Document</link>, create one - stating the title, year, authors, and publisher of the - Document as given on its Title Page, then add an item - describing the Modified Version 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 Document, and likewise the network locations - given in the Document for previous versions it was based - on. These may be placed in the <quote>History</quote> - section. You may omit a network location for a work that - was published at least four years before the Document - 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 <quote>Acknowledgements</quote> or - <quote>Dedications</quote>, 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 - <quote>Endorsements</quote>. 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 - <quote>Endorsements</quote> 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 - Modified Version's license notice. These titles must be - distinct from any other section titles. - </para> - - <para> - You may add a section entitled <quote>Endorsements</quote>, - 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 Front-Cover Text and one of Back-Cover Text - 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> - </sect1> - - <sect1 id="fdl-section5"> - <title>5. COMBINING DOCUMENTS</title> - <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 Invariant Sections 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 Invariant Sections 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 Invariant Sections in the license notice of the combined - work. - </para> - - <para> - In the combination, you must combine any sections entitled - <quote>History</quote> in the various original documents, - forming one section entitled <quote>History</quote>; likewise - combine any sections entitled <quote>Acknowledgements</quote>, - and any sections entitled <quote>Dedications</quote>. You must - delete all sections entitled <quote>Endorsements.</quote> - </para> - </sect1> - - <sect1 id="fdl-section6"> - <title>6. COLLECTIONS OF DOCUMENTS</title> - <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 - dispbibute 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> - </sect1> - - <sect1 id="fdl-section7"> - <title>7. AGGREGATION WITH INDEPENDENT WORKS</title> - <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 Document, provided no compilation copyright is claimed - for the compilation. Such a compilation is called an - <quote>aggregate</quote>, and this License does not apply to the - other self-contained works thus compiled with the Document , on - account of their being thus compiled, if they are not themselves - derivative works of the Document. 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 Document, then if the Document is less than one - quarter of the entire aggregate, the Document's Cover Texts may - be placed on covers that surround only the Document within the - aggregate. Otherwise they must appear on covers around the whole - aggregate. - </para> - </sect1> - - <sect1 id="fdl-section8"> - <title>8. TRANSLATION</title> - <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 - Invariant Sections in addition to the original versions of these - Invariant Sections. 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> - </sect1> - - <sect1 id="fdl-section9"> - <title>9. TERMINATION</title> - <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 Document 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> - </sect1> - - <sect1 id="fdl-section10"> - <title>10. FUTURE REVISIONS OF THIS LICENSE</title> - <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 - <quote>or any later version</quote> 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 Document 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> - </sect1> - - <sect1 id="fdl-using"> - <title>Addendum</title> - <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> - - <blockquote> - <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> - </blockquote> - - <para> - If you have no <link linkend="fdl-invariant">Invariant - Sections</link>, write <quote>with no Invariant Sections</quote> - instead of saying which ones are invariant. If you have no - <link linkend="fdl-cover-texts">Front-Cover Texts</link>, write - <quote>no Front-Cover Texts</quote> instead of - <quote>Front-Cover Texts being LIST</quote>; 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> - </sect1> -</appendix> - - - - - - diff --git a/doc/devel/importer/.cvsignore b/doc/devel/importer/.cvsignore deleted file mode 100644 index 439d6641ff..0000000000 --- a/doc/devel/importer/.cvsignore +++ /dev/null @@ -1,10 +0,0 @@ -sgml -Makefile -Makefile.in -*-decl.txt -*-decl-list.txt -*-unused.txt -*.hierarchy -*.signals -*.stamp -*-scan.c diff --git a/doc/devel/importer/Makefile.am b/doc/devel/importer/Makefile.am deleted file mode 100644 index 8b5343677a..0000000000 --- a/doc/devel/importer/Makefile.am +++ /dev/null @@ -1,195 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# The name of the module, e.g. 'glib'. -DOC_MODULE=evolution-shell-importer - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=$(EVOLUTION_DIR)/shell/importer - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - -# Used for dependencies. -HFILE_GLOB= \ - $(top_srcdir)/shell/importer/evolution-importer.h \ - $(top_srcdir)/shell/importer/evolution-importer-client.h - -CFILE_GLOB= \ - $(top_srcdir)/shell/importer/evolution-importer.c \ - $(top_srcdir)/shell/importer/evolution-importer-client.c - -# Header files to ignore when scanning. -IGNORE_HFILES= \ - GNOME_Evolution_Importer.h \ - importer.h - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS = \ - -I$(top_srcdir)/shell/importer \ - -I$(top_srcdir)/shell \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(BONOBO_VFS_GNOME_CFLAGS) - -GTKDOC_LIBS = \ - $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/shell/importer/.libs/libevolution-importer.so - -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in this file -# and uncomment this line. -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt -DOC_OVERRIDES = - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals - -if ENABLE_GTK_DOC -#all-local: html-build.stamp -all-local: sgml-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -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); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml - mkdir $(distdir)/html - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml - -cp $(srcdir)/html/index.sgml $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -.PHONY : dist-hook-local - - diff --git a/doc/devel/importer/evolution-shell-importer-sections.txt b/doc/devel/importer/evolution-shell-importer-sections.txt deleted file mode 100644 index e2474f6375..0000000000 --- a/doc/devel/importer/evolution-shell-importer-sections.txt +++ /dev/null @@ -1,79 +0,0 @@ -<INCLUDE>evolution-importer.h</INCLUDE> - -<SECTION> -<FILE>evolution-importer</FILE> -EVOLUTION_IMPORTER -<TITLE>EvolutionImporter</TITLE> - -EvolutionImporterSupportFormatFn -EvolutionImporterLoadFileFn -EvolutionImporterProcessItemFn -EvolutionImporterGetErrorFn - -EvolutionImporterResult - -evolution_importer_new - -<SUBSECTION Standard> -EVOLUTION_TYPE_IMPORTER -EVOLUTION_IMPORTER -EVOLUTION_IS_IMPORTER -EVOLUTION_IMPORTER_CLASS -EVOLUTION_IS_IMPORTER_CLASS -evolution_importer_get_type - -<SUBSECTION Private> -EvolutionImporter -EvolutionImporterPrivate - -</SECTION> - -<INCLUDE>evolution-importer-listener.h</INCLUDE> -<SECTION> -<FILE>evolution-importer-listener</FILE> -EVOLUTION_IMPORTER_LISTENER -<TITLE>EvolutionImporterListener</TITLE> - -EvolutionImporterListenerCallback - -evolution_importer_listener_new - -<SUBSECTION Standard> -EVOLUTION_TYPE_IMPORTER_LISTENER -EVOLUTION_IMPORTER_LISTENER -EVOLUTION_IMPORTER_LISTENER_CLASS -EVOLUTION_IS_IMPORTER_LISTENER -EVOLUTION_IS_IMPORTER_LISTENER_CLASS -evolution_importer_listener_get_type - -<SUBSECTION Private> -EvolutionImporterListener -EvolutionImporterListenerPrivate - -</SECTION> - -<INCLUDE>evolution-importer-client.h</INCLUDE> -<SECTION> -<FILE>evolution-importer-client</FILE> -EVOLUTION_IMPORTER_CLIENT -<TITLE>EvolutionImporterClient</TITLE> - -evolution_importer_client_new -evolution_importer_client_new_from_id -evolution_importer_client_support_format -evolution_importer_client_load_file -evolution_importer_client_process_item -evolution_importer_client_get_error - -<SUBSECTION Standard> -EVOLUTION_TYPE_IMPORTER_CLIENT -EVOLUTION_IMPORTER_CLIENT -EVOLUTION_IMPORTER_CLIENT_CLASS -EVOLUTION_IS_IMPORTER_CLIENT -EVOLUTION_IS_IMPORTER_CLIENT_CLASS -evolution_importer_client_get_type - -<SUBSECTION Private> -EvolutionImporterClient - -</SECTION> diff --git a/doc/devel/importer/evolution-shell-importer.args b/doc/devel/importer/evolution-shell-importer.args deleted file mode 100644 index e69de29bb2..0000000000 --- a/doc/devel/importer/evolution-shell-importer.args +++ /dev/null diff --git a/doc/devel/importer/evolution-shell-importer.hierarchy b/doc/devel/importer/evolution-shell-importer.hierarchy deleted file mode 100644 index c46ebdf782..0000000000 --- a/doc/devel/importer/evolution-shell-importer.hierarchy +++ /dev/null @@ -1,7 +0,0 @@ -GtkObject - BonoboObject - BonoboXObject - EvolutionImporter - EvolutionImporterListener - Handle to remote Bonobo::Unknown - EvolutionImporterClient diff --git a/doc/devel/importer/evolution-shell-importer.types b/doc/devel/importer/evolution-shell-importer.types deleted file mode 100644 index e787818599..0000000000 --- a/doc/devel/importer/evolution-shell-importer.types +++ /dev/null @@ -1,9 +0,0 @@ -#include <gnome.h> -#include <bonobo.h> -#include <shell/importer/evolution-importer.h> -#include <shell/importer/evolution-importer-client.h> -#include <shell/importer/evolution-importer-listener.h> - -evolution_importer_get_type -evolution_importer_client_get_type -evolution_importer_listener_get_type diff --git a/doc/devel/importer/private-reference.sgml b/doc/devel/importer/private-reference.sgml deleted file mode 100644 index d28c7b8591..0000000000 --- a/doc/devel/importer/private-reference.sgml +++ /dev/null @@ -1,21 +0,0 @@ - <reference id="importer-private-reference"> - <title>Importer Private API Reference</title> - - <partintro> - <para> - This part presents the class and function reference for the - private APIs of the different components of the &Evolution; - Import Framework. - </para> - </partintro> - - &EvolutionImporterListener; - &EvolutionImporterClient; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/importer/public-reference.sgml b/doc/devel/importer/public-reference.sgml deleted file mode 100644 index ba99c9b309..0000000000 --- a/doc/devel/importer/public-reference.sgml +++ /dev/null @@ -1,20 +0,0 @@ - <reference id="importer-public-reference"> - <title>Importer 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; - Import Framework. - </para> - </partintro> - - &EvolutionImporter; - </reference> - -<!-- -Local variables: -mode: sgml -sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") -End: ---> diff --git a/doc/devel/importer/tmpl/evolution-importer-client.sgml b/doc/devel/importer/tmpl/evolution-importer-client.sgml deleted file mode 100644 index 6cee37bef1..0000000000 --- a/doc/devel/importer/tmpl/evolution-importer-client.sgml +++ /dev/null @@ -1,84 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EvolutionImporterClient - -<!-- ##### SECTION Short_Description ##### --> -A #GtkObject based client to simplify use of a GNOME_Evolution_Importer object. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This #GtkObject provides a convience wrapper to the GNOME_Evolution_Importer object, providing error checking and hiding all the CORBA internals from the user. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EVOLUTION_IMPORTER_CLIENT ##### --> -<para> -Casts a #GtkObject into an #EvolutionImporterClient -</para> - -@obj: A #GtkObject - - -<!-- ##### FUNCTION evolution_importer_client_new ##### --> -<para> - -</para> - -@objref: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_new_from_id ##### --> -<para> - -</para> - -@id: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_support_format ##### --> -<para> - -</para> - -@client: -@filename: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_load_file ##### --> -<para> - -</para> - -@client: -@filename: -@folderpath: -@Returns: - - -<!-- ##### FUNCTION evolution_importer_client_process_item ##### --> -<para> - -</para> - -@client: -@listener: -<!-- # Unused Parameters # --> -@callback: -@closure: - - -<!-- ##### FUNCTION evolution_importer_client_get_error ##### --> -<para> - -</para> - -@client: -@Returns: - - diff --git a/doc/devel/importer/tmpl/evolution-importer.sgml b/doc/devel/importer/tmpl/evolution-importer.sgml deleted file mode 100644 index 1c7736a37f..0000000000 --- a/doc/devel/importer/tmpl/evolution-importer.sgml +++ /dev/null @@ -1,96 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EvolutionImporter - -<!-- ##### SECTION Short_Description ##### --> -A #BonoboObject that implements the GNOME/Evolution/Importer interface. - -<!-- ##### SECTION Long_Description ##### --> -<para> -A #BonoboObject wrapper around the GNOME/Evolution/Importer interface, providing error checking and reference counting, hiding the CORBA internals from the user and providing a simple way to create a GNOME_Evolution_Importer object. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO EVOLUTION_IMPORTER ##### --> -<para> -Casts a #GtkObject into an #EvolutionImporter. -</para> - -@obj: A #GtkObject. - - -<!-- ##### USER_FUNCTION EvolutionImporterSupportFormatFn ##### --> -<para> -The type of function that is called when the importer wishes to find out if the importing component can support the file given in @filename. -</para> - -@importer: The #EvolutionImporter. -@filename: The filename of the file to check. -@closure: The data passed into evolution_importer_new (). -@Returns: A #gboolean. TRUE if the importing component can import the file, FALSE otherwise. - - -<!-- ##### USER_FUNCTION EvolutionImporterLoadFileFn ##### --> -<para> -The type of function that is called when the importer wishes the importing component to load the file given in @filename, and initialise itself. -</para> - -@importer: The #EvolutionImporter. -@filename: The filename of the file to load. -@folderpath: -@closure: The data passed into evolution_importer_new (). -@Returns: A #gboolean. TRUE if the load and initialisation was successful, FALSE otherwise. - - -<!-- ##### USER_FUNCTION EvolutionImporterProcessItemFn ##### --> -<para> -The type of function that is called when the importer wants the importing component to process the next item (or items) in a file. -</para> - -@importer: The #EvolutionImporter -@listener: A GNOME_Evolution_Importer_Listener CORBA object. -@closure: The data passed into evolution_importer_new (). -@ev: A #CORBA_Environment for returning any CORBA exceptions. - - -<!-- ##### USER_FUNCTION EvolutionImporterGetErrorFn ##### --> -<para> -The type of function that is called when the importer wants to get a string version of an error. Not all importing components support this function. -</para> - -@importer: The #EvolutionImporter. -@closure: The data passed to evolution_importer_new (). -@Returns: A string representation of the error, or NULL if there was no error, or the importing component does not support the getError method. - - -<!-- ##### ENUM EvolutionImporterResult ##### --> -<para> - -</para> - -@EVOLUTION_IMPORTER_OK: -@EVOLUTION_IMPORTER_UNSUPPORTED_OPERATION: -@EVOLUTION_IMPORTER_INTERRUPTED: -@EVOLUTION_IMPORTER_BUSY: -@EVOLUTION_IMPORTER_NOT_READY: -@EVOLUTION_IMPORTER_UNKNOWN_DATA: -@EVOLUTION_IMPORTER_BAD_DATA: -@EVOLUTION_IMPORTER_BAD_FILE: -@EVOLUTION_IMPORTER_UNKNOWN_ERROR: - -<!-- ##### FUNCTION evolution_importer_new ##### --> -<para> - -</para> - -@support_format_fn: -@load_file_fn: -@process_item_fn: -@get_error_fn: -@closure: -@Returns: - - diff --git a/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml b/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml deleted file mode 100644 index 7a9a98034b..0000000000 --- a/doc/devel/importer/tmpl/evolution-shell-importer-unused.sgml +++ /dev/null @@ -1,10 +0,0 @@ -<!-- ##### USER_FUNCTION EvolutionImporterClientCallback ##### --> -<para> - -</para> - -@client: -@result: -@more_items: -@data: - diff --git a/doc/devel/preface.sgml b/doc/devel/preface.sgml deleted file mode 100644 index fdaa824a8b..0000000000 --- a/doc/devel/preface.sgml +++ /dev/null @@ -1,113 +0,0 @@ - <preface id="introduction"> - <title>Introduction</title> - - <para> - This is the &Evolution; Developer's Guide or programming guide - for the &Evolution; groupware suite. If you are a programmer - and you wish to use &Evolution;'s functionality from your own - applications or if you wish to modify the &Evolution; core code, - you should read this guide. - </para> - - <para> - If you are an end-user of &Evolution; you do not need to read - this guide; please read the &Evolution; User's Guide instead. - </para> - - <para> - This guide contains the information you need to know to do the - following: - - <itemizedlist> - <listitem> - <para> - Write applications that use &Evolution;'s data - repositories via the &Wombat; personal information server. - Examples of this would be a <application>GNOME - Panel</application> applet that displays today's - appointments, or a telephone dialer application that uses - the contents of the &Evolution; Addressbook. - </para> - </listitem> - - <listitem> - <para> - Write applications that use the &Camel; mail library. - This includes extending &Evolution;'s own mail component - to perform additional functions. - </para> - </listitem> - - <listitem> - <para> - Write new components for the &Evolution; Shell. Instead - of writing a stand-alone application, you can provide your - users with the benefit of having integrated views of their - data from within Evolution. - </para> - </listitem> - - <listitem> - <para> - Write new modules for the &Evolution; Executive Summary. - This allows you to present commonly-accessed information - in a convenient fashion directly in the &Evolution; Shell. - </para> - </listitem> - - <listitem> - <para> - Modify the core &Evolution; code to add new features or - change its architecture. - </para> - </listitem> - </itemizedlist> - </para> - - <sect1 id="organization"> - <title>Organization of this Guide</title> - - <para> - This guide is organized in two big sections. The first is a - programming guide, which consists of one part for each one of - &Evolution;'s components: there are separate parts for the - calendar, the addressbook, the mailer, the executive summary, - and the shell. Each part gives a description of the - architecture of its corresponding component, and also gives - information about the component's internal architecture and - some implementation details. - </para> - - <para> - The second section of this guide is a reference guide for - &Evolution;'s programming interfaces. We have separated these - into public and private interfaces. The public ones are those - that most people will need to use when writing extensions or - third-party components; the private interfaces are those used - internally in &Evolution;. Even if you do not intend to - modify the &Evolution; core code, it may be useful to know a - bit about the way it is organized internally. - </para> - - <para> - &Evolution; is free software, and we want you as a programmer - to make the most of it. We have provided many useful - interfaces that you can use in your own applications. Still, - we want you to view &Evolution; as a framework for building - groupware applications, and this may occasionally involve - making changes to its core code. We want you to learn from - &Evolution;'s design because we think it marks an important - milestone in the development of large-scale free software - applications. We want you to modify it as you see fit. Free - software gives you this freedom, and we want the whole world - to benefit from it. - </para> - </sect1> - </preface> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("evolution-devel-guide.sgml" "book" "book" "") -End: ---> diff --git a/doc/devel/reference.sgml b/doc/devel/reference.sgml deleted file mode 100644 index 4381ad29b7..0000000000 --- a/doc/devel/reference.sgml +++ /dev/null @@ -1,49 +0,0 @@ - <part id="evolution-api-reference"> - <title>&Evolution; 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> - - <para> - &Evolution; provides two kinds of interfaces, public and - private. The public interfaces are those designed to be used - from third-party applications or components; if you wanted to - write an application that uses &Evolution;'s data repositories - to display data in a particular way, you would use the public - interfaces. The private interfaces are those used inside - &Evolution; itself; these are generally not interesting unless - you intend to make modifications to the &Evolution; code base. - </para> - - <para> - While the public and private interfaces are described in - separate reference sections, we have decided to put them - together in the same book, this guide, because we want to - encourage you to regard &Evolution; as something more than a - black box that stores and dispatches personal information. We - want you to make modifications to the &Evolution; core if - these would allow you to present or store your data in better - ways. &Evolution; is free software; we want you to learn from - its design and implementation details so that you can make it - even better for the whole world to use. - </para> - </partintro> - - &calendar-public-reference; - <!-- &importer-public-reference; --> - <!-- &evolution-services-public-reference; --> - <!-- &importer-private-reference; --> - <!-- &evolution-services-private-reference; --> - </part> - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("evolution-devel-guide.sgml" "book" "book" "") -End: ---> 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 5f5ea27a98..0000000000 --- a/doc/white-papers/mail/camel.sgml +++ /dev/null @@ -1,356 +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>Jeffrey</firstname> - <surname>Stedfast</surname> - <affiliation> - <address> - <email>fejj@helixcode.com</email> - </address> - </affiliation> - </author> - - <author> - <firstname>Michael</firstname> - <surname>Zucchi</surname> - <affiliation> - <address> - <email>notzed@helixcode.com</email> - </address> - </affiliation> - </author> - - <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, 2001</year> - <holder>Ximian, 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 subclassed - <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 POP, 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</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 filtered. So a CamelMimePart - containing base64-encoded data can filter its output through - CamelMimeFilterBasic. 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> |